Move LikeMatch to Rdbms namespace
[mediawiki.git] / includes / DefaultSettings.php
bloba1a4067f565880be072de98ac9fa8090c0417683
1 <?php
2 /**
3 * Default values for MediaWiki configuration settings.
6 * NEVER EDIT THIS FILE
9 * To customize your installation, edit "LocalSettings.php". If you make
10 * changes here, they will be lost on next upgrade of MediaWiki!
12 * In this file, variables whose default values depend on other
13 * variables are set to false. The actual default value of these variables
14 * will only be set in Setup.php, taking into account any custom settings
15 * performed in LocalSettings.php.
17 * Documentation is in the source and on:
18 * 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
38 * @file
41 /**
42 * @defgroup Globalsettings Global settings
45 /**
46 * @cond file_level_code
47 * This is not a valid entry point, perform no further processing unless
48 * MEDIAWIKI is defined
50 if ( !defined( 'MEDIAWIKI' ) ) {
51 echo "This file is part of MediaWiki and is not a valid entry point\n";
52 die( 1 );
55 /** @endcond */
57 /**
58 * wgConf hold the site configuration.
59 * Not used for much in a default install.
60 * @since 1.5
62 $wgConf = new SiteConfiguration;
64 /**
65 * Registry of factory functions to create config objects:
66 * The 'main' key must be set, and the value should be a valid
67 * callable.
68 * @since 1.23
70 $wgConfigRegistry = [
71 'main' => 'GlobalVarConfig::newInstance'
74 /**
75 * MediaWiki version number
76 * @since 1.2
78 $wgVersion = '1.29.0-alpha';
80 /**
81 * Name of the site. It must be changed in LocalSettings.php
83 $wgSitename = 'MediaWiki';
85 /**
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).
88 * @var bool
89 * @since 1.26
91 $wgAssumeProxiesUseDefaultProtocolPorts = true;
93 /**
94 * URL of the server.
96 * @par Example:
97 * @code
98 * $wgServer = 'http://example.com';
99 * @endcode
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.
116 * @since 1.18
118 $wgCanonicalServer = false;
121 * Server name. This is automatically computed by parsing the bare
122 * hostname out of $wgCanonicalServer. It should not be customized.
123 * @since 1.24
125 $wgServerName = false;
127 /************************************************************************//**
128 * @name Script path settings
129 * @{
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.
158 * @since 1.2.1
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.
170 * @since 1.11
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';
177 /**@}*/
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.
194 * @{
198 * The URL path to index.php.
200 * Defaults to "{$wgScriptPath}/index.php".
202 $wgScript = false;
205 * The URL path to load.php.
207 * Defaults to "{$wgScriptPath}/load.php".
208 * @since 1.17
210 $wgLoadScript = false;
213 * The URL path of the skins directory.
214 * Defaults to "{$wgResourceBasePath}/skins".
215 * @since 1.3
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".
223 * @since 1.17
225 $wgLocalStylePath = false;
228 * The URL path of the extensions directory.
229 * Defaults to "{$wgResourceBasePath}/extensions".
230 * @since 1.16
232 $wgExtensionAssetsPath = false;
235 * Filesystem extensions directory.
236 * Defaults to "{$IP}/extensions".
237 * @since 1.25
239 $wgExtensionDirectory = "{$IP}/extensions";
242 * Filesystem stylesheets directory.
243 * Defaults to "{$IP}/skins".
244 * @since 1.3
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".
278 $wgLogo = false;
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.
285 * @par Example:
286 * @code
287 * $wgLogoHD = [
288 * "1.5x" => "path/to/1.5x_version.png",
289 * "2x" => "path/to/2x_version.png"
290 * ];
291 * @endcode
293 * @since 1.25
295 $wgLogoHD = false;
298 * The URL path of the shortcut icon.
299 * @since 1.6
301 $wgFavicon = '/favicon.ico';
304 * The URL path of the icon for iPhone and iPod Touch web app bookmarks.
305 * Defaults to no icon.
306 * @since 1.12
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 https://www.w3.org/TR/referrer-policy/ for details.
316 * @since 1.25
318 $wgReferrerPolicy = false;
321 * The local filesystem path to a temporary directory. This is not required to
322 * be web accessible.
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
326 * logic.
328 * Developers should use the global function wfTempDir() instead of this
329 * variable.
331 * @see wfTempDir()
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
338 * upload URL.
339 * @since 1.4
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.
348 * @since 1.17
350 $wgUploadStashScalerBaseUrl = false;
353 * To set 'pretty' URL paths for actions other than
354 * plain page views, add to this array.
356 * @par Example:
357 * Set pretty URL for the edit action:
358 * @code
359 * 'edit' => "$wgScriptPath/edit/$1"
360 * @endcode
362 * There must be an appropriate script or rewrite rule in place to handle these
363 * URLs.
364 * @since 1.5
366 $wgActionPaths = [];
368 /**@}*/
370 /************************************************************************//**
371 * @name Files and file uploads
372 * @{
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
405 * completeness.
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.
427 * Example:
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.
447 * - name A unique name for the repository (but $wgLocalFileRepo should be 'local').
448 * The name should consist of alpha-numeric characters.
449 * - backend A file backend name (see $wgFileBackends).
451 * For most core repos:
452 * - zones Associative array of zone names that each map to an array with:
453 * container : backend container name the zone is in
454 * directory : root path within container for the zone
455 * url : base URL to the root of the zone
456 * urlsByExt : map of file extension types to base URLs
457 * (useful for using a different cache for videos)
458 * Zones default to using "<repo name>-<zone name>" as the container name
459 * and default to using the container root as the zone's root directory.
460 * Nesting of zone locations within other zones should be avoided.
461 * - url Public zone URL. The 'zones' settings take precedence.
462 * - hashLevels The number of directory levels for hash-based division of files
463 * - thumbScriptUrl The URL for thumb.php (optional, not recommended)
464 * - transformVia404 Whether to skip media file transformation on parse and rely on a 404
465 * handler instead.
466 * - initialCapital Equivalent to $wgCapitalLinks (or $wgCapitalLinkOverrides[NS_FILE],
467 * determines whether filenames implicitly start with a capital letter.
468 * The current implementation may give incorrect description page links
469 * when the local $wgCapitalLinks and initialCapital are mismatched.
470 * - pathDisclosureProtection
471 * May be 'paranoid' to remove all parameters from error messages, 'none' to
472 * leave the paths in unchanged, or 'simple' to replace paths with
473 * placeholders. Default for LocalRepo is 'simple'.
474 * - fileMode This allows wikis to set the file mode when uploading/moving files. Default
475 * is 0644.
476 * - directory The local filesystem directory where public files are stored. Not used for
477 * some remote repos.
478 * - thumbDir The base thumbnail directory. Defaults to "<directory>/thumb".
479 * - thumbUrl The base thumbnail URL. Defaults to "<url>/thumb".
480 * - isPrivate Set this if measures should always be taken to keep the files private.
481 * One should not trust this to assure that the files are not web readable;
482 * the server configuration should be done manually depending on the backend.
484 * These settings describe a foreign MediaWiki installation. They are optional, and will be ignored
485 * for local repositories:
486 * - descBaseUrl URL of image description pages, e.g. https://en.wikipedia.org/wiki/File:
487 * - scriptDirUrl URL of the MediaWiki installation, equivalent to $wgScriptPath, e.g.
488 * https://en.wikipedia.org/w
489 * - scriptExtension Script extension of the MediaWiki installation, equivalent to
490 * $wgScriptExtension, e.g. ".php5". Defaults to ".php".
492 * - articleUrl Equivalent to $wgArticlePath, e.g. https://en.wikipedia.org/wiki/$1
493 * - fetchDescription Fetch the text of the remote file description page. Equivalent to
494 * $wgFetchCommonsDescriptions.
495 * - abbrvThreshold File names over this size will use the short form of thumbnail names.
496 * Short thumbnail names only have the width, parameters, and the extension.
498 * ForeignDBRepo:
499 * - dbType, dbServer, dbUser, dbPassword, dbName, dbFlags
500 * equivalent to the corresponding member of $wgDBservers
501 * - tablePrefix Table prefix, the foreign wiki's $wgDBprefix
502 * - hasSharedCache True if the wiki's shared cache is accessible via the local $wgMemc
504 * ForeignAPIRepo:
505 * - apibase Use for the foreign API's URL
506 * - apiThumbCacheExpiry How long to locally cache thumbs for
508 * If you leave $wgLocalFileRepo set to false, Setup will fill in appropriate values.
509 * Otherwise, set $wgLocalFileRepo to a repository structure as described above.
510 * If you set $wgUseInstantCommons to true, it will add an entry for Commons.
511 * If you set $wgForeignFileRepos to an array of repository structures, those will
512 * be searched after the local file repo.
513 * Otherwise, you will only have access to local media files.
515 * @see Setup.php for an example usage and default initialization.
517 $wgLocalFileRepo = false;
520 * @see $wgLocalFileRepo
522 $wgForeignFileRepos = [];
525 * Use Commons as a remote file repository. Essentially a wrapper, when this
526 * is enabled $wgForeignFileRepos will point at Commons with a set of default
527 * settings
529 $wgUseInstantCommons = false;
532 * Array of foreign file repo names (set in $wgForeignFileRepos above) that
533 * are allowable upload targets. These wikis must have some method of
534 * authentication (i.e. CentralAuth), and be CORS-enabled for this wiki.
535 * The string 'local' signifies the default local file repository.
537 * Example:
538 * $wgForeignUploadTargets = [ 'shared' ];
540 $wgForeignUploadTargets = [ 'local' ];
543 * Configuration for file uploads using the embeddable upload dialog
544 * (https://www.mediawiki.org/wiki/Upload_dialog).
546 * This applies also to foreign uploads to this wiki (the configuration is loaded by remote wikis
547 * using the action=query&meta=siteinfo API).
549 * See below for documentation of each property. None of the properties may be omitted.
551 $wgUploadDialog = [
552 // Fields to make available in the dialog. `true` means that this field is visible, `false` means
553 // that it is hidden. The "Name" field can't be hidden. Note that you also have to add the
554 // matching replacement to the 'filepage' format key below to make use of these.
555 'fields' => [
556 'description' => true,
557 'date' => false,
558 'categories' => false,
560 // Suffix of localisation messages used to describe the license under which the uploaded file will
561 // be released. The same value may be set for both 'local' and 'foreign' uploads.
562 'licensemessages' => [
563 // The 'local' messages are used for local uploads on this wiki:
564 // * upload-form-label-own-work-message-generic-local
565 // * upload-form-label-not-own-work-message-generic-local
566 // * upload-form-label-not-own-work-local-generic-local
567 'local' => 'generic-local',
568 // The 'foreign' messages are used for cross-wiki uploads from other wikis to this wiki:
569 // * upload-form-label-own-work-message-generic-foreign
570 // * upload-form-label-not-own-work-message-generic-foreign
571 // * upload-form-label-not-own-work-local-generic-foreign
572 'foreign' => 'generic-foreign',
574 // Upload comments to use for 'local' and 'foreign' uploads. This can also be set to a single
575 // string value, in which case it is used for both kinds of uploads. Available replacements:
576 // * $HOST - domain name from which a cross-wiki upload originates
577 // * $PAGENAME - wiki page name from which an upload originates
578 'comment' => [
579 'local' => '',
580 'foreign' => '',
582 // Format of the file page wikitext to be generated from the fields input by the user.
583 'format' => [
584 // Wrapper for the whole page. Available replacements:
585 // * $DESCRIPTION - file description, as input by the user (only if the 'description' field is
586 // enabled), wrapped as defined below in the 'description' key
587 // * $DATE - file creation date, as input by the user (only if the 'date' field is enabled)
588 // * $SOURCE - as defined below in the 'ownwork' key, may be extended in the future
589 // * $AUTHOR - linked user name, may be extended in the future
590 // * $LICENSE - as defined below in the 'license' key, may be extended in the future
591 // * $CATEGORIES - file categories wikitext, as input by the user (only if the 'categories'
592 // field is enabled), or if no input, as defined below in the 'uncategorized' key
593 'filepage' => '$DESCRIPTION',
594 // Wrapped for file description. Available replacements:
595 // * $LANGUAGE - source wiki's content language
596 // * $TEXT - input by the user
597 'description' => '$TEXT',
598 'ownwork' => '',
599 'license' => '',
600 'uncategorized' => '',
605 * File backend structure configuration.
607 * This is an array of file backend configuration arrays.
608 * Each backend configuration has the following parameters:
609 * - 'name' : A unique name for the backend
610 * - 'class' : The file backend class to use
611 * - 'wikiId' : A unique string that identifies the wiki (container prefix)
612 * - 'lockManager' : The name of a lock manager (see $wgLockManagers)
614 * See FileBackend::__construct() for more details.
615 * Additional parameters are specific to the file backend class used.
616 * These settings should be global to all wikis when possible.
618 * FileBackendMultiWrite::__construct() is augmented with a 'template' option that
619 * can be used in any of the values of the 'backends' array. Its value is the name of
620 * another backend in $wgFileBackends. When set, it pre-fills the array with all of the
621 * configuration of the named backend. Explicitly set values in the array take precedence.
623 * There are two particularly important aspects about each backend:
624 * - a) Whether it is fully qualified or wiki-relative.
625 * By default, the paths of files are relative to the current wiki,
626 * which works via prefixing them with the current wiki ID when accessed.
627 * Setting 'wikiId' forces the backend to be fully qualified by prefixing
628 * all paths with the specified value instead. This can be useful if
629 * multiple wikis need to share the same data. Note that 'name' is *not*
630 * part of any prefix and thus should not be relied upon for namespacing.
631 * - b) Whether it is only defined for some wikis or is defined on all
632 * wikis in the wiki farm. Defining a backend globally is useful
633 * if multiple wikis need to share the same data.
634 * One should be aware of these aspects when configuring a backend for use with
635 * any basic feature or plugin. For example, suppose an extension stores data for
636 * different wikis in different directories and sometimes needs to access data from
637 * a foreign wiki's directory in order to render a page on given wiki. The extension
638 * would need a fully qualified backend that is defined on all wikis in the wiki farm.
640 $wgFileBackends = [];
643 * Array of configuration arrays for each lock manager.
644 * Each backend configuration has the following parameters:
645 * - 'name' : A unique name for the lock manager
646 * - 'class' : The lock manger class to use
648 * See LockManager::__construct() for more details.
649 * Additional parameters are specific to the lock manager class used.
650 * These settings should be global to all wikis.
652 * When using DBLockManager, the 'dbsByBucket' map can reference 'localDBMaster' as
653 * a peer database in each bucket. This will result in an extra connection to the domain
654 * that the LockManager services, which must also be a valid wiki ID.
656 $wgLockManagers = [];
659 * Show Exif data, on by default if available.
660 * Requires PHP's Exif extension: https://secure.php.net/manual/en/ref.exif.php
662 * @note FOR WINDOWS USERS:
663 * To enable Exif functions, add the following line to the "Windows
664 * extensions" section of php.ini:
665 * @code{.ini}
666 * extension=extensions/php_exif.dll
667 * @endcode
669 $wgShowEXIF = function_exists( 'exif_read_data' );
672 * If to automatically update the img_metadata field
673 * if the metadata field is outdated but compatible with the current version.
674 * Defaults to false.
676 $wgUpdateCompatibleMetadata = false;
679 * If you operate multiple wikis, you can define a shared upload path here.
680 * Uploads to this wiki will NOT be put there - they will be put into
681 * $wgUploadDirectory.
682 * If $wgUseSharedUploads is set, the wiki will look in the shared repository if
683 * no file of the given name is found in the local repository (for [[File:..]],
684 * [[Media:..]] links). Thumbnails will also be looked for and generated in this
685 * directory.
687 * Note that these configuration settings can now be defined on a per-
688 * repository basis for an arbitrary number of file repositories, using the
689 * $wgForeignFileRepos variable.
691 $wgUseSharedUploads = false;
694 * Full path on the web server where shared uploads can be found
696 $wgSharedUploadPath = null;
699 * Fetch commons image description pages and display them on the local wiki?
701 $wgFetchCommonsDescriptions = false;
704 * Path on the file system where shared uploads can be found.
706 $wgSharedUploadDirectory = null;
709 * DB name with metadata about shared directory.
710 * Set this to false if the uploads do not come from a wiki.
712 $wgSharedUploadDBname = false;
715 * Optional table prefix used in database.
717 $wgSharedUploadDBprefix = '';
720 * Cache shared metadata in memcached.
721 * Don't do this if the commons wiki is in a different memcached domain
723 $wgCacheSharedUploads = true;
726 * Allow for upload to be copied from an URL.
727 * The timeout for copy uploads is set by $wgCopyUploadTimeout.
728 * You have to assign the user right 'upload_by_url' to a user group, to use this.
730 $wgAllowCopyUploads = false;
733 * A list of domains copy uploads can come from
735 * @since 1.20
737 $wgCopyUploadsDomains = [];
740 * Enable copy uploads from Special:Upload. $wgAllowCopyUploads must also be
741 * true. If $wgAllowCopyUploads is true, but this is false, you will only be
742 * able to perform copy uploads from the API or extensions (e.g. UploadWizard).
744 $wgCopyUploadsFromSpecialUpload = false;
747 * Proxy to use for copy upload requests.
748 * @since 1.20
750 $wgCopyUploadProxy = false;
753 * Different timeout for upload by url
754 * This could be useful since when fetching large files, you may want a
755 * timeout longer than the default $wgHTTPTimeout. False means fallback
756 * to default.
758 * @since 1.22
760 $wgCopyUploadTimeout = false;
763 * Max size for uploads, in bytes. If not set to an array, applies to all
764 * uploads. If set to an array, per upload type maximums can be set, using the
765 * file and url keys. If the * key is set this value will be used as maximum
766 * for non-specified types.
768 * @par Example:
769 * @code
770 * $wgMaxUploadSize = [
771 * '*' => 250 * 1024,
772 * 'url' => 500 * 1024,
773 * ];
774 * @endcode
775 * Sets the maximum for all uploads to 250 kB except for upload-by-url, which
776 * will have a maximum of 500 kB.
778 $wgMaxUploadSize = 1024 * 1024 * 100; # 100MB
781 * Minimum upload chunk size, in bytes. When using chunked upload, non-final
782 * chunks smaller than this will be rejected. May be reduced based on the
783 * 'upload_max_filesize' or 'post_max_size' PHP settings.
784 * @since 1.26
786 $wgMinUploadChunkSize = 1024; # 1KB
789 * Point the upload navigation link to an external URL
790 * Useful if you want to use a shared repository by default
791 * without disabling local uploads (use $wgEnableUploads = false for that).
793 * @par Example:
794 * @code
795 * $wgUploadNavigationUrl = 'https://commons.wikimedia.org/wiki/Special:Upload';
796 * @endcode
798 $wgUploadNavigationUrl = false;
801 * Point the upload link for missing files to an external URL, as with
802 * $wgUploadNavigationUrl. The URL will get "(?|&)wpDestFile=<filename>"
803 * appended to it as appropriate.
805 $wgUploadMissingFileUrl = false;
808 * Give a path here to use thumb.php for thumbnail generation on client
809 * request, instead of generating them on render and outputting a static URL.
810 * This is necessary if some of your apache servers don't have read/write
811 * access to the thumbnail path.
813 * @par Example:
814 * @code
815 * $wgThumbnailScriptPath = "{$wgScriptPath}/thumb.php";
816 * @endcode
818 $wgThumbnailScriptPath = false;
821 * @see $wgThumbnailScriptPath
823 $wgSharedThumbnailScriptPath = false;
826 * Set this to false if you do not want MediaWiki to divide your images
827 * directory into many subdirectories, for improved performance.
829 * It's almost always good to leave this enabled. In previous versions of
830 * MediaWiki, some users set this to false to allow images to be added to the
831 * wiki by simply copying them into $wgUploadDirectory and then running
832 * maintenance/rebuildImages.php to register them in the database. This is no
833 * longer recommended, use maintenance/importImages.php instead.
835 * @note That this variable may be ignored if $wgLocalFileRepo is set.
836 * @todo Deprecate the setting and ultimately remove it from Core.
838 $wgHashedUploadDirectory = true;
841 * Set the following to false especially if you have a set of files that need to
842 * be accessible by all wikis, and you do not want to use the hash (path/a/aa/)
843 * directory layout.
845 $wgHashedSharedUploadDirectory = true;
848 * Base URL for a repository wiki. Leave this blank if uploads are just stored
849 * in a shared directory and not meant to be accessible through a separate wiki.
850 * Otherwise the image description pages on the local wiki will link to the
851 * image description page on this wiki.
853 * Please specify the namespace, as in the example below.
855 $wgRepositoryBaseUrl = "https://commons.wikimedia.org/wiki/File:";
858 * This is the list of preferred extensions for uploading files. Uploading files
859 * with extensions not in this list will trigger a warning.
861 * @warning If you add any OpenOffice or Microsoft Office file formats here,
862 * such as odt or doc, and untrusted users are allowed to upload files, then
863 * your wiki will be vulnerable to cross-site request forgery (CSRF).
865 $wgFileExtensions = [ 'png', 'gif', 'jpg', 'jpeg', 'webp' ];
868 * Files with these extensions will never be allowed as uploads.
869 * An array of file extensions to blacklist. You should append to this array
870 * if you want to blacklist additional files.
872 $wgFileBlacklist = [
873 # HTML may contain cookie-stealing JavaScript and web bugs
874 'html', 'htm', 'js', 'jsb', 'mhtml', 'mht', 'xhtml', 'xht',
875 # PHP scripts may execute arbitrary code on the server
876 'php', 'phtml', 'php3', 'php4', 'php5', 'phps',
877 # Other types that may be interpreted by some servers
878 'shtml', 'jhtml', 'pl', 'py', 'cgi',
879 # May contain harmful executables for Windows victims
880 'exe', 'scr', 'dll', 'msi', 'vbs', 'bat', 'com', 'pif', 'cmd', 'vxd', 'cpl' ];
883 * Files with these MIME types will never be allowed as uploads
884 * if $wgVerifyMimeType is enabled.
886 $wgMimeTypeBlacklist = [
887 # HTML may contain cookie-stealing JavaScript and web bugs
888 'text/html', 'text/javascript', 'text/x-javascript', 'application/x-shellscript',
889 # PHP scripts may execute arbitrary code on the server
890 'application/x-php', 'text/x-php',
891 # Other types that may be interpreted by some servers
892 'text/x-python', 'text/x-perl', 'text/x-bash', 'text/x-sh', 'text/x-csh',
893 # Client-side hazards on Internet Explorer
894 'text/scriptlet', 'application/x-msdownload',
895 # Windows metafile, client-side vulnerability on some systems
896 'application/x-msmetafile',
900 * Allow Java archive uploads.
901 * This is not recommended for public wikis since a maliciously-constructed
902 * applet running on the same domain as the wiki can steal the user's cookies.
904 $wgAllowJavaUploads = false;
907 * This is a flag to determine whether or not to check file extensions on upload.
909 * @warning Setting this to false is insecure for public wikis.
911 $wgCheckFileExtensions = true;
914 * If this is turned off, users may override the warning for files not covered
915 * by $wgFileExtensions.
917 * @warning Setting this to false is insecure for public wikis.
919 $wgStrictFileExtensions = true;
922 * Setting this to true will disable the upload system's checks for HTML/JavaScript.
924 * @warning THIS IS VERY DANGEROUS on a publicly editable site, so USE
925 * $wgGroupPermissions TO RESTRICT UPLOADING to only those that you trust
927 $wgDisableUploadScriptChecks = false;
930 * Warn if uploaded files are larger than this (in bytes), or false to disable
932 $wgUploadSizeWarning = false;
935 * list of trusted media-types and MIME types.
936 * Use the MEDIATYPE_xxx constants to represent media types.
937 * This list is used by File::isSafeFile
939 * Types not listed here will have a warning about unsafe content
940 * displayed on the images description page. It would also be possible
941 * to use this for further restrictions, like disabling direct
942 * [[media:...]] links for non-trusted formats.
944 $wgTrustedMediaFormats = [
945 MEDIATYPE_BITMAP, // all bitmap formats
946 MEDIATYPE_AUDIO, // all audio formats
947 MEDIATYPE_VIDEO, // all plain video formats
948 "image/svg+xml", // svg (only needed if inline rendering of svg is not supported)
949 "application/pdf", // PDF files
950 # "application/x-shockwave-flash", //flash/shockwave movie
954 * Plugins for media file type handling.
955 * Each entry in the array maps a MIME type to a class name
957 * Core media handlers are listed in MediaHandlerFactory,
958 * and extensions should use extension.json.
960 $wgMediaHandlers = [];
963 * Plugins for page content model handling.
964 * Each entry in the array maps a model id to a class name or callback
965 * that creates an instance of the appropriate ContentHandler subclass.
967 * @since 1.21
969 $wgContentHandlers = [
970 // the usual case
971 CONTENT_MODEL_WIKITEXT => 'WikitextContentHandler',
972 // dumb version, no syntax highlighting
973 CONTENT_MODEL_JAVASCRIPT => 'JavaScriptContentHandler',
974 // simple implementation, for use by extensions, etc.
975 CONTENT_MODEL_JSON => 'JsonContentHandler',
976 // dumb version, no syntax highlighting
977 CONTENT_MODEL_CSS => 'CssContentHandler',
978 // plain text, for use by extensions, etc.
979 CONTENT_MODEL_TEXT => 'TextContentHandler',
983 * Whether to enable server-side image thumbnailing. If false, images will
984 * always be sent to the client in full resolution, with appropriate width= and
985 * height= attributes on the <img> tag for the client to do its own scaling.
987 $wgUseImageResize = true;
990 * Resizing can be done using PHP's internal image libraries or using
991 * ImageMagick or another third-party converter, e.g. GraphicMagick.
992 * These support more file formats than PHP, which only supports PNG,
993 * GIF, JPG, XBM and WBMP.
995 * Use Image Magick instead of PHP builtin functions.
997 $wgUseImageMagick = false;
1000 * The convert command shipped with ImageMagick
1002 $wgImageMagickConvertCommand = '/usr/bin/convert';
1005 * Array of max pixel areas for interlacing per MIME type
1006 * @since 1.27
1008 $wgMaxInterlacingAreas = [];
1011 * Sharpening parameter to ImageMagick
1013 $wgSharpenParameter = '0x0.4';
1016 * Reduction in linear dimensions below which sharpening will be enabled
1018 $wgSharpenReductionThreshold = 0.85;
1021 * Temporary directory used for ImageMagick. The directory must exist. Leave
1022 * this set to false to let ImageMagick decide for itself.
1024 $wgImageMagickTempDir = false;
1027 * Use another resizing converter, e.g. GraphicMagick
1028 * %s will be replaced with the source path, %d with the destination
1029 * %w and %h will be replaced with the width and height.
1031 * @par Example for GraphicMagick:
1032 * @code
1033 * $wgCustomConvertCommand = "gm convert %s -resize %wx%h %d"
1034 * @endcode
1036 * Leave as false to skip this.
1038 $wgCustomConvertCommand = false;
1041 * used for lossless jpeg rotation
1043 * @since 1.21
1045 $wgJpegTran = '/usr/bin/jpegtran';
1048 * At default setting of 'yuv420', JPEG thumbnails will use 4:2:0 chroma
1049 * subsampling to reduce file size, at the cost of possible color fringing
1050 * at sharp edges.
1052 * See https://en.wikipedia.org/wiki/Chroma_subsampling
1054 * Supported values:
1055 * false - use scaling system's default (same as pre-1.27 behavior)
1056 * 'yuv444' - luma and chroma at same resolution
1057 * 'yuv422' - chroma at 1/2 resolution horizontally, full vertically
1058 * 'yuv420' - chroma at 1/2 resolution in both dimensions
1060 * This setting is currently supported only for the ImageMagick backend;
1061 * others may default to 4:2:0 or 4:4:4 or maintaining the source file's
1062 * sampling in the thumbnail.
1064 * @since 1.27
1066 $wgJpegPixelFormat = 'yuv420';
1069 * Some tests and extensions use exiv2 to manipulate the Exif metadata in some
1070 * image formats.
1072 $wgExiv2Command = '/usr/bin/exiv2';
1075 * Path to exiftool binary. Used for lossless ICC profile swapping.
1077 * @since 1.26
1079 $wgExiftool = '/usr/bin/exiftool';
1082 * Scalable Vector Graphics (SVG) may be uploaded as images.
1083 * Since SVG support is not yet standard in browsers, it is
1084 * necessary to rasterize SVGs to PNG as a fallback format.
1086 * An external program is required to perform this conversion.
1087 * If set to an array, the first item is a PHP callable and any further items
1088 * are passed as parameters after $srcPath, $dstPath, $width, $height
1090 $wgSVGConverters = [
1091 'ImageMagick' =>
1092 '$path/convert -background "#ffffff00" -thumbnail $widthx$height\! $input PNG:$output',
1093 'sodipodi' => '$path/sodipodi -z -w $width -f $input -e $output',
1094 'inkscape' => '$path/inkscape -z -w $width -f $input -e $output',
1095 'batik' => 'java -Djava.awt.headless=true -jar $path/batik-rasterizer.jar -w $width -d '
1096 . '$output $input',
1097 'rsvg' => '$path/rsvg-convert -w $width -h $height -o $output $input',
1098 'imgserv' => '$path/imgserv-wrapper -i svg -o png -w$width $input $output',
1099 'ImagickExt' => [ 'SvgHandler::rasterizeImagickExt' ],
1103 * Pick a converter defined in $wgSVGConverters
1105 $wgSVGConverter = 'ImageMagick';
1108 * If not in the executable PATH, specify the SVG converter path.
1110 $wgSVGConverterPath = '';
1113 * Don't scale a SVG larger than this
1115 $wgSVGMaxSize = 5120;
1118 * Don't read SVG metadata beyond this point.
1119 * Default is 1024*256 bytes
1121 $wgSVGMetadataCutoff = 262144;
1124 * Disallow <title> element in SVG files.
1126 * MediaWiki will reject HTMLesque tags in uploaded files due to idiotic
1127 * browsers which can not perform basic stuff like MIME detection and which are
1128 * vulnerable to further idiots uploading crap files as images.
1130 * When this directive is on, "<title>" will be allowed in files with an
1131 * "image/svg+xml" MIME type. You should leave this disabled if your web server
1132 * is misconfigured and doesn't send appropriate MIME types for SVG images.
1134 $wgAllowTitlesInSVG = false;
1137 * The maximum number of pixels a source image can have if it is to be scaled
1138 * down by a scaler that requires the full source image to be decompressed
1139 * and stored in decompressed form, before the thumbnail is generated.
1141 * This provides a limit on memory usage for the decompression side of the
1142 * image scaler. The limit is used when scaling PNGs with any of the
1143 * built-in image scalers, such as ImageMagick or GD. It is ignored for
1144 * JPEGs with ImageMagick, and when using the VipsScaler extension.
1146 * The default is 50 MB if decompressed to RGBA form, which corresponds to
1147 * 12.5 million pixels or 3500x3500.
1149 $wgMaxImageArea = 1.25e7;
1152 * Force thumbnailing of animated GIFs above this size to a single
1153 * frame instead of an animated thumbnail. As of MW 1.17 this limit
1154 * is checked against the total size of all frames in the animation.
1155 * It probably makes sense to keep this equal to $wgMaxImageArea.
1157 $wgMaxAnimatedGifArea = 1.25e7;
1160 * Browsers don't support TIFF inline generally...
1161 * For inline display, we need to convert to PNG or JPEG.
1162 * Note scaling should work with ImageMagick, but may not with GD scaling.
1164 * @par Example:
1165 * @code
1166 * // PNG is lossless, but inefficient for photos
1167 * $wgTiffThumbnailType = [ 'png', 'image/png' ];
1168 * // JPEG is good for photos, but has no transparency support. Bad for diagrams.
1169 * $wgTiffThumbnailType = [ 'jpg', 'image/jpeg' ];
1170 * @endcode
1172 $wgTiffThumbnailType = false;
1175 * If rendered thumbnail files are older than this timestamp, they
1176 * will be rerendered on demand as if the file didn't already exist.
1177 * Update if there is some need to force thumbs and SVG rasterizations
1178 * to rerender, such as fixes to rendering bugs.
1180 $wgThumbnailEpoch = '20030516000000';
1183 * Certain operations are avoided if there were too many recent failures,
1184 * for example, thumbnail generation. Bump this value to invalidate all
1185 * memory of failed operations and thus allow further attempts to resume.
1186 * This is useful when a cause for the failures has been found and fixed.
1188 $wgAttemptFailureEpoch = 1;
1191 * If set, inline scaled images will still produce "<img>" tags ready for
1192 * output instead of showing an error message.
1194 * This may be useful if errors are transitory, especially if the site
1195 * is configured to automatically render thumbnails on request.
1197 * On the other hand, it may obscure error conditions from debugging.
1198 * Enable the debug log or the 'thumbnail' log group to make sure errors
1199 * are logged to a file for review.
1201 $wgIgnoreImageErrors = false;
1204 * Allow thumbnail rendering on page view. If this is false, a valid
1205 * thumbnail URL is still output, but no file will be created at
1206 * the target location. This may save some time if you have a
1207 * thumb.php or 404 handler set up which is faster than the regular
1208 * webserver(s).
1210 $wgGenerateThumbnailOnParse = true;
1213 * Show thumbnails for old images on the image description page
1215 $wgShowArchiveThumbnails = true;
1218 * If set to true, images that contain certain the exif orientation tag will
1219 * be rotated accordingly. If set to null, try to auto-detect whether a scaler
1220 * is available that can rotate.
1222 $wgEnableAutoRotation = null;
1225 * Internal name of virus scanner. This serves as a key to the
1226 * $wgAntivirusSetup array. Set this to NULL to disable virus scanning. If not
1227 * null, every file uploaded will be scanned for viruses.
1229 $wgAntivirus = null;
1232 * Configuration for different virus scanners. This an associative array of
1233 * associative arrays. It contains one setup array per known scanner type.
1234 * The entry is selected by $wgAntivirus, i.e.
1235 * valid values for $wgAntivirus are the keys defined in this array.
1237 * The configuration array for each scanner contains the following keys:
1238 * "command", "codemap", "messagepattern":
1240 * "command" is the full command to call the virus scanner - %f will be
1241 * replaced with the name of the file to scan. If not present, the filename
1242 * will be appended to the command. Note that this must be overwritten if the
1243 * scanner is not in the system path; in that case, please set
1244 * $wgAntivirusSetup[$wgAntivirus]['command'] to the desired command with full
1245 * path.
1247 * "codemap" is a mapping of exit code to return codes of the detectVirus
1248 * function in SpecialUpload.
1249 * - An exit code mapped to AV_SCAN_FAILED causes the function to consider
1250 * the scan to be failed. This will pass the file if $wgAntivirusRequired
1251 * is not set.
1252 * - An exit code mapped to AV_SCAN_ABORTED causes the function to consider
1253 * the file to have an unsupported format, which is probably immune to
1254 * viruses. This causes the file to pass.
1255 * - An exit code mapped to AV_NO_VIRUS will cause the file to pass, meaning
1256 * no virus was found.
1257 * - All other codes (like AV_VIRUS_FOUND) will cause the function to report
1258 * a virus.
1259 * - You may use "*" as a key in the array to catch all exit codes not mapped otherwise.
1261 * "messagepattern" is a perl regular expression to extract the meaningful part of the scanners
1262 * output. The relevant part should be matched as group one (\1).
1263 * If not defined or the pattern does not match, the full message is shown to the user.
1265 $wgAntivirusSetup = [
1267 # setup for clamav
1268 'clamav' => [
1269 'command' => 'clamscan --no-summary ',
1270 'codemap' => [
1271 "0" => AV_NO_VIRUS, # no virus
1272 "1" => AV_VIRUS_FOUND, # virus found
1273 "52" => AV_SCAN_ABORTED, # unsupported file format (probably immune)
1274 "*" => AV_SCAN_FAILED, # else scan failed
1276 'messagepattern' => '/.*?:(.*)/sim',
1281 * Determines if a failed virus scan (AV_SCAN_FAILED) will cause the file to be rejected.
1283 $wgAntivirusRequired = true;
1286 * Determines if the MIME type of uploaded files should be checked
1288 $wgVerifyMimeType = true;
1291 * Sets the MIME type definition file to use by MimeMagic.php.
1292 * Set to null, to use built-in defaults only.
1293 * example: $wgMimeTypeFile = '/etc/mime.types';
1295 $wgMimeTypeFile = 'includes/mime.types';
1298 * Sets the MIME type info file to use by MimeMagic.php.
1299 * Set to null, to use built-in defaults only.
1301 $wgMimeInfoFile = 'includes/mime.info';
1304 * Sets an external MIME detector program. The command must print only
1305 * the MIME type to standard output.
1306 * The name of the file to process will be appended to the command given here.
1307 * If not set or NULL, PHP's fileinfo extension will be used if available.
1309 * @par Example:
1310 * @code
1311 * #$wgMimeDetectorCommand = "file -bi"; # use external MIME detector (Linux)
1312 * @endcode
1314 $wgMimeDetectorCommand = null;
1317 * Switch for trivial MIME detection. Used by thumb.php to disable all fancy
1318 * things, because only a few types of images are needed and file extensions
1319 * can be trusted.
1321 $wgTrivialMimeDetection = false;
1324 * Additional XML types we can allow via MIME-detection.
1325 * array = [ 'rootElement' => 'associatedMimeType' ]
1327 $wgXMLMimeTypes = [
1328 'http://www.w3.org/2000/svg:svg' => 'image/svg+xml',
1329 'svg' => 'image/svg+xml',
1330 'http://www.lysator.liu.se/~alla/dia/:diagram' => 'application/x-dia-diagram',
1331 'http://www.w3.org/1999/xhtml:html' => 'text/html', // application/xhtml+xml?
1332 'html' => 'text/html', // application/xhtml+xml?
1336 * Limit images on image description pages to a user-selectable limit. In order
1337 * to reduce disk usage, limits can only be selected from a list.
1338 * The user preference is saved as an array offset in the database, by default
1339 * the offset is set with $wgDefaultUserOptions['imagesize']. Make sure you
1340 * change it if you alter the array (see bug 8858).
1341 * This is the list of settings the user can choose from:
1343 $wgImageLimits = [
1344 [ 320, 240 ],
1345 [ 640, 480 ],
1346 [ 800, 600 ],
1347 [ 1024, 768 ],
1348 [ 1280, 1024 ]
1352 * Adjust thumbnails on image pages according to a user setting. In order to
1353 * reduce disk usage, the values can only be selected from a list. This is the
1354 * list of settings the user can choose from:
1356 $wgThumbLimits = [
1357 120,
1358 150,
1359 180,
1360 200,
1361 250,
1366 * When defined, is an array of image widths used as buckets for thumbnail generation.
1367 * The goal is to save resources by generating thumbnails based on reference buckets instead of
1368 * always using the original. This will incur a speed gain but cause a quality loss.
1370 * The buckets generation is chained, with each bucket generated based on the above bucket
1371 * when possible. File handlers have to opt into using that feature. For now only BitmapHandler
1372 * supports it.
1374 $wgThumbnailBuckets = null;
1377 * When using thumbnail buckets as defined above, this sets the minimum distance to the bucket
1378 * above the requested size. The distance represents how many extra pixels of width the bucket
1379 * needs in order to be used as the reference for a given thumbnail. For example, with the
1380 * following buckets:
1382 * $wgThumbnailBuckets = [ 128, 256, 512 ];
1384 * and a distance of 50:
1386 * $wgThumbnailMinimumBucketDistance = 50;
1388 * If we want to render a thumbnail of width 220px, the 512px bucket will be used,
1389 * because 220 + 50 = 270 and the closest bucket bigger than 270px is 512.
1391 $wgThumbnailMinimumBucketDistance = 50;
1394 * When defined, is an array of thumbnail widths to be rendered at upload time. The idea is to
1395 * prerender common thumbnail sizes, in order to avoid the necessity to render them on demand, which
1396 * has a performance impact for the first client to view a certain size.
1398 * This obviously means that more disk space is needed per upload upfront.
1400 * @since 1.25
1403 $wgUploadThumbnailRenderMap = [];
1406 * The method through which the thumbnails will be prerendered for the entries in
1407 * $wgUploadThumbnailRenderMap
1409 * The method can be either "http" or "jobqueue". The former uses an http request to hit the
1410 * thumbnail's URL.
1411 * This method only works if thumbnails are configured to be rendered by a 404 handler. The latter
1412 * option uses the job queue to render the thumbnail.
1414 * @since 1.25
1416 $wgUploadThumbnailRenderMethod = 'jobqueue';
1419 * When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom Host HTTP header.
1421 * @since 1.25
1423 $wgUploadThumbnailRenderHttpCustomHost = false;
1426 * When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom domain to send the
1427 * HTTP request to.
1429 * @since 1.25
1431 $wgUploadThumbnailRenderHttpCustomDomain = false;
1434 * When this variable is true and JPGs use the sRGB ICC profile, swaps it for the more lightweight
1435 * (and free) TinyRGB profile when generating thumbnails.
1437 * @since 1.26
1439 $wgUseTinyRGBForJPGThumbnails = false;
1442 * Default parameters for the "<gallery>" tag
1444 $wgGalleryOptions = [
1445 'imagesPerRow' => 0, // Default number of images per-row in the gallery. 0 -> Adapt to screensize
1446 'imageWidth' => 120, // Width of the cells containing images in galleries (in "px")
1447 'imageHeight' => 120, // Height of the cells containing images in galleries (in "px")
1448 'captionLength' => true, // Deprecated @since 1.28
1449 // Length to truncate filename to in caption when using "showfilename".
1450 // A value of 'true' will truncate the filename to one line using CSS
1451 // and will be the behaviour after deprecation.
1452 'showBytes' => true, // Show the filesize in bytes in categories
1453 'mode' => 'traditional',
1457 * Adjust width of upright images when parameter 'upright' is used
1458 * This allows a nicer look for upright images without the need to fix the width
1459 * by hardcoded px in wiki sourcecode.
1461 $wgThumbUpright = 0.75;
1464 * Default value for chmoding of new directories.
1466 $wgDirectoryMode = 0777;
1469 * Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities.
1471 * This means a 320x240 use of an image on the wiki will also generate 480x360 and 640x480
1472 * thumbnails, output via the srcset attribute.
1474 * On older browsers, a JavaScript polyfill switches the appropriate images in after loading
1475 * the original low-resolution versions depending on the reported window.devicePixelRatio.
1476 * The polyfill can be found in the jquery.hidpi module.
1478 $wgResponsiveImages = true;
1481 * @name DJVU settings
1482 * @{
1486 * Path of the djvudump executable
1487 * Enable this and $wgDjvuRenderer to enable djvu rendering
1488 * example: $wgDjvuDump = 'djvudump';
1490 $wgDjvuDump = null;
1493 * Path of the ddjvu DJVU renderer
1494 * Enable this and $wgDjvuDump to enable djvu rendering
1495 * example: $wgDjvuRenderer = 'ddjvu';
1497 $wgDjvuRenderer = null;
1500 * Path of the djvutxt DJVU text extraction utility
1501 * Enable this and $wgDjvuDump to enable text layer extraction from djvu files
1502 * example: $wgDjvuTxt = 'djvutxt';
1504 $wgDjvuTxt = null;
1507 * Path of the djvutoxml executable
1508 * This works like djvudump except much, much slower as of version 3.5.
1510 * For now we recommend you use djvudump instead. The djvuxml output is
1511 * probably more stable, so we'll switch back to it as soon as they fix
1512 * the efficiency problem.
1513 * https://sourceforge.net/tracker/index.php?func=detail&aid=1704049&group_id=32953&atid=406583
1515 * @par Example:
1516 * @code
1517 * $wgDjvuToXML = 'djvutoxml';
1518 * @endcode
1520 $wgDjvuToXML = null;
1523 * Shell command for the DJVU post processor
1524 * Default: pnmtojpeg, since ddjvu generates ppm output
1525 * Set this to false to output the ppm file directly.
1527 $wgDjvuPostProcessor = 'pnmtojpeg';
1530 * File extension for the DJVU post processor output
1532 $wgDjvuOutputExtension = 'jpg';
1534 /** @} */ # end of DJvu }
1536 /** @} */ # end of file uploads }
1538 /************************************************************************//**
1539 * @name Email settings
1540 * @{
1544 * Site admin email address.
1546 * Defaults to "wikiadmin@$wgServerName".
1548 $wgEmergencyContact = false;
1551 * Sender email address for e-mail notifications.
1553 * The address we use as sender when a user requests a password reminder.
1555 * Defaults to "apache@$wgServerName".
1557 $wgPasswordSender = false;
1560 * Sender name for e-mail notifications.
1562 * @deprecated since 1.23; use the system message 'emailsender' instead.
1564 $wgPasswordSenderName = 'MediaWiki Mail';
1567 * Reply-To address for e-mail notifications.
1569 * Defaults to $wgPasswordSender.
1571 $wgNoReplyAddress = false;
1574 * Set to true to enable the e-mail basic features:
1575 * Password reminders, etc. If sending e-mail on your
1576 * server doesn't work, you might want to disable this.
1578 $wgEnableEmail = true;
1581 * Set to true to enable user-to-user e-mail.
1582 * This can potentially be abused, as it's hard to track.
1584 $wgEnableUserEmail = true;
1587 * If true put the sending user's email in a Reply-To header
1588 * instead of From (false). ($wgPasswordSender will be used as From.)
1590 * Some mailers (eg SMTP) set the SMTP envelope sender to the From value,
1591 * which can cause problems with SPF validation and leak recipient addresses
1592 * when bounces are sent to the sender. In addition, DMARC restrictions
1593 * can cause emails to fail to be received when false.
1595 $wgUserEmailUseReplyTo = true;
1598 * Minimum time, in hours, which must elapse between password reminder
1599 * emails for a given account. This is to prevent abuse by mail flooding.
1601 $wgPasswordReminderResendTime = 24;
1604 * The time, in seconds, when an emailed temporary password expires.
1606 $wgNewPasswordExpiry = 3600 * 24 * 7;
1609 * The time, in seconds, when an email confirmation email expires
1611 $wgUserEmailConfirmationTokenExpiry = 7 * 24 * 60 * 60;
1614 * The number of days that a user's password is good for. After this number of days, the
1615 * user will be asked to reset their password. Set to false to disable password expiration.
1617 $wgPasswordExpirationDays = false;
1620 * If a user's password is expired, the number of seconds when they can still login,
1621 * and cancel their password change, but are sent to the password change form on each login.
1623 $wgPasswordExpireGrace = 3600 * 24 * 7; // 7 days
1626 * SMTP Mode.
1628 * For using a direct (authenticated) SMTP server connection.
1629 * Default to false or fill an array :
1631 * @code
1632 * $wgSMTP = [
1633 * 'host' => 'SMTP domain',
1634 * 'IDHost' => 'domain for MessageID',
1635 * 'port' => '25',
1636 * 'auth' => [true|false],
1637 * 'username' => [SMTP username],
1638 * 'password' => [SMTP password],
1639 * ];
1640 * @endcode
1642 $wgSMTP = false;
1645 * Additional email parameters, will be passed as the last argument to mail() call.
1647 $wgAdditionalMailParams = null;
1650 * For parts of the system that have been updated to provide HTML email content, send
1651 * both text and HTML parts as the body of the email
1653 $wgAllowHTMLEmail = false;
1656 * True: from page editor if s/he opted-in. False: Enotif mails appear to come
1657 * from $wgEmergencyContact
1659 $wgEnotifFromEditor = false;
1661 // TODO move UPO to preferences probably ?
1662 # If set to true, users get a corresponding option in their preferences and can choose to
1663 # enable or disable at their discretion
1664 # If set to false, the corresponding input form on the user preference page is suppressed
1665 # It call this to be a "user-preferences-option (UPO)"
1668 * Require email authentication before sending mail to an email address.
1669 * This is highly recommended. It prevents MediaWiki from being used as an open
1670 * spam relay.
1672 $wgEmailAuthentication = true;
1675 * Allow users to enable email notification ("enotif") on watchlist changes.
1677 $wgEnotifWatchlist = false;
1680 * Allow users to enable email notification ("enotif") when someone edits their
1681 * user talk page.
1683 * The owner of the user talk page must also have the 'enotifusertalkpages' user
1684 * preference set to true.
1686 $wgEnotifUserTalk = false;
1689 * Set the Reply-to address in notifications to the editor's address, if user
1690 * allowed this in the preferences.
1692 $wgEnotifRevealEditorAddress = false;
1695 * Potentially send notification mails on minor edits to pages. This is enabled
1696 * by default. If this is false, users will never be notified on minor edits.
1698 * If it is true, editors with the 'nominornewtalk' right (typically bots) will still not
1699 * trigger notifications for minor edits they make (to any page, not just user talk).
1701 * Finally, if the watcher/recipient has the 'enotifminoredits' user preference set to
1702 * false, they will not receive notifications for minor edits.
1704 * User talk notifications are also affected by $wgEnotifMinorEdits, the above settings,
1705 * $wgEnotifUserTalk, and the preference described there.
1707 $wgEnotifMinorEdits = true;
1710 * Send a generic mail instead of a personalised mail for each user. This
1711 * always uses UTC as the time zone, and doesn't include the username.
1713 * For pages with many users watching, this can significantly reduce mail load.
1714 * Has no effect when using sendmail rather than SMTP.
1716 $wgEnotifImpersonal = false;
1719 * Maximum number of users to mail at once when using impersonal mail. Should
1720 * match the limit on your mail server.
1722 $wgEnotifMaxRecips = 500;
1725 * Use real name instead of username in e-mail "from" field.
1727 $wgEnotifUseRealName = false;
1730 * Array of usernames who will be sent a notification email for every change
1731 * which occurs on a wiki. Users will not be notified of their own changes.
1733 $wgUsersNotifiedOnAllChanges = [];
1735 /** @} */ # end of email settings
1737 /************************************************************************//**
1738 * @name Database settings
1739 * @{
1743 * Database host name or IP address
1745 $wgDBserver = 'localhost';
1748 * Database port number (for PostgreSQL and Microsoft SQL Server).
1750 $wgDBport = 5432;
1753 * Name of the database
1755 $wgDBname = 'my_wiki';
1758 * Database username
1760 $wgDBuser = 'wikiuser';
1763 * Database user's password
1765 $wgDBpassword = '';
1768 * Database type
1770 $wgDBtype = 'mysql';
1773 * Whether to use SSL in DB connection.
1775 * This setting is only used $wgLBFactoryConf['class'] is set to
1776 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
1777 * the DBO_SSL flag must be set in the 'flags' option of the database
1778 * connection to achieve the same functionality.
1780 $wgDBssl = false;
1783 * Whether to use compression in DB connection.
1785 * This setting is only used $wgLBFactoryConf['class'] is set to
1786 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
1787 * the DBO_COMPRESS flag must be set in the 'flags' option of the database
1788 * connection to achieve the same functionality.
1790 $wgDBcompress = false;
1793 * Separate username for maintenance tasks. Leave as null to use the default.
1795 $wgDBadminuser = null;
1798 * Separate password for maintenance tasks. Leave as null to use the default.
1800 $wgDBadminpassword = null;
1803 * Search type.
1804 * Leave as null to select the default search engine for the
1805 * selected database type (eg SearchMySQL), or set to a class
1806 * name to override to a custom search engine.
1808 $wgSearchType = null;
1811 * Alternative search types
1812 * Sometimes you want to support multiple search engines for testing. This
1813 * allows users to select their search engine of choice via url parameters
1814 * to Special:Search and the action=search API. If using this, there's no
1815 * need to add $wgSearchType to it, that is handled automatically.
1817 $wgSearchTypeAlternatives = null;
1820 * Table name prefix
1822 $wgDBprefix = '';
1825 * MySQL table options to use during installation or update
1827 $wgDBTableOptions = 'ENGINE=InnoDB';
1830 * SQL Mode - default is turning off all modes, including strict, if set.
1831 * null can be used to skip the setting for performance reasons and assume
1832 * DBA has done his best job.
1833 * String override can be used for some additional fun :-)
1835 $wgSQLMode = '';
1838 * Mediawiki schema
1840 $wgDBmwschema = null;
1843 * To override default SQLite data directory ($docroot/../data)
1845 $wgSQLiteDataDir = '';
1848 * Shared database for multiple wikis. Commonly used for storing a user table
1849 * for single sign-on. The server for this database must be the same as for the
1850 * main database.
1852 * For backwards compatibility the shared prefix is set to the same as the local
1853 * prefix, and the user table is listed in the default list of shared tables.
1854 * The user_properties table is also added so that users will continue to have their
1855 * preferences shared (preferences were stored in the user table prior to 1.16)
1857 * $wgSharedTables may be customized with a list of tables to share in the shared
1858 * database. However it is advised to limit what tables you do share as many of
1859 * MediaWiki's tables may have side effects if you try to share them.
1861 * $wgSharedPrefix is the table prefix for the shared database. It defaults to
1862 * $wgDBprefix.
1864 * $wgSharedSchema is the table schema for the shared database. It defaults to
1865 * $wgDBmwschema.
1867 * @deprecated since 1.21 In new code, use the $wiki parameter to wfGetLB() to
1868 * access remote databases. Using wfGetLB() allows the shared database to
1869 * reside on separate servers to the wiki's own database, with suitable
1870 * configuration of $wgLBFactoryConf.
1872 $wgSharedDB = null;
1875 * @see $wgSharedDB
1877 $wgSharedPrefix = false;
1880 * @see $wgSharedDB
1882 $wgSharedTables = [ 'user', 'user_properties' ];
1885 * @see $wgSharedDB
1886 * @since 1.23
1888 $wgSharedSchema = false;
1891 * Database load balancer
1892 * This is a two-dimensional array, an array of server info structures
1893 * Fields are:
1894 * - host: Host name
1895 * - dbname: Default database name
1896 * - user: DB user
1897 * - password: DB password
1898 * - type: DB type
1900 * - load: Ratio of DB_REPLICA load, must be >=0, the sum of all loads must be >0.
1901 * If this is zero for any given server, no normal query traffic will be
1902 * sent to it. It will be excluded from lag checks in maintenance scripts.
1903 * The only way it can receive traffic is if groupLoads is used.
1905 * - groupLoads: array of load ratios, the key is the query group name. A query may belong
1906 * to several groups, the most specific group defined here is used.
1908 * - flags: bit field
1909 * - DBO_DEFAULT -- turns on DBO_TRX only if "cliMode" is off (recommended)
1910 * - DBO_DEBUG -- equivalent of $wgDebugDumpSql
1911 * - DBO_TRX -- wrap entire request in a transaction
1912 * - DBO_NOBUFFER -- turn off buffering (not useful in LocalSettings.php)
1913 * - DBO_PERSISTENT -- enables persistent database connections
1914 * - DBO_SSL -- uses SSL/TLS encryption in database connections, if available
1915 * - DBO_COMPRESS -- uses internal compression in database connections,
1916 * if available
1918 * - max lag: (optional) Maximum replication lag before a replica DB goes out of rotation
1919 * - is static: (optional) Set to true if the dataset is static and no replication is used.
1920 * - cliMode: (optional) Connection handles will not assume that requests are short-lived
1921 * nor that INSERT..SELECT can be rewritten into a buffered SELECT and INSERT.
1922 * [Default: uses value of $wgCommandLineMode]
1924 * These and any other user-defined properties will be assigned to the mLBInfo member
1925 * variable of the Database object.
1927 * Leave at false to use the single-server variables above. If you set this
1928 * variable, the single-server variables will generally be ignored (except
1929 * perhaps in some command-line scripts).
1931 * The first server listed in this array (with key 0) will be the master. The
1932 * rest of the servers will be replica DBs. To prevent writes to your replica DBs due to
1933 * accidental misconfiguration or MediaWiki bugs, set read_only=1 on all your
1934 * replica DBs in my.cnf. You can set read_only mode at runtime using:
1936 * @code
1937 * SET @@read_only=1;
1938 * @endcode
1940 * Since the effect of writing to a replica DB is so damaging and difficult to clean
1941 * up, we at Wikimedia set read_only=1 in my.cnf on all our DB servers, even
1942 * our masters, and then set read_only=0 on masters at runtime.
1944 $wgDBservers = false;
1947 * Load balancer factory configuration
1948 * To set up a multi-master wiki farm, set the class here to something that
1949 * can return a LoadBalancer with an appropriate master on a call to getMainLB().
1950 * The class identified here is responsible for reading $wgDBservers,
1951 * $wgDBserver, etc., so overriding it may cause those globals to be ignored.
1953 * The LBFactoryMulti class is provided for this purpose, please see
1954 * includes/db/LBFactoryMulti.php for configuration information.
1956 $wgLBFactoryConf = [ 'class' => 'LBFactorySimple' ];
1959 * After a state-changing request is done by a client, this determines
1960 * how many seconds that client should keep using the master datacenter.
1961 * This avoids unexpected stale or 404 responses due to replication lag.
1962 * @since 1.27
1964 $wgDataCenterUpdateStickTTL = 10;
1967 * File to log database errors to
1969 $wgDBerrorLog = false;
1972 * Timezone to use in the error log.
1973 * Defaults to the wiki timezone ($wgLocaltimezone).
1975 * A list of usable timezones can found at:
1976 * https://secure.php.net/manual/en/timezones.php
1978 * @par Examples:
1979 * @code
1980 * $wgDBerrorLogTZ = 'UTC';
1981 * $wgDBerrorLogTZ = 'GMT';
1982 * $wgDBerrorLogTZ = 'PST8PDT';
1983 * $wgDBerrorLogTZ = 'Europe/Sweden';
1984 * $wgDBerrorLogTZ = 'CET';
1985 * @endcode
1987 * @since 1.20
1989 $wgDBerrorLogTZ = false;
1992 * Set to true to engage MySQL 4.1/5.0 charset-related features;
1993 * for now will just cause sending of 'SET NAMES=utf8' on connect.
1995 * @warning THIS IS EXPERIMENTAL!
1997 * May break if you're not using the table defs from mysql5/tables.sql.
1998 * May break if you're upgrading an existing wiki if set differently.
1999 * Broken symptoms likely to include incorrect behavior with page titles,
2000 * usernames, comments etc containing non-ASCII characters.
2001 * Might also cause failures on the object cache and other things.
2003 * Even correct usage may cause failures with Unicode supplementary
2004 * characters (those not in the Basic Multilingual Plane) unless MySQL
2005 * has enhanced their Unicode support.
2007 $wgDBmysql5 = false;
2010 * Set true to enable Oracle DCRP (supported from 11gR1 onward)
2012 * To use this feature set to true and use a datasource defined as
2013 * POOLED (i.e. in tnsnames definition set server=pooled in connect_data
2014 * block).
2016 * Starting from 11gR1 you can use DCRP (Database Resident Connection
2017 * Pool) that maintains established sessions and reuses them on new
2018 * connections.
2020 * Not completely tested, but it should fall back on normal connection
2021 * in case the pool is full or the datasource is not configured as
2022 * pooled.
2023 * And the other way around; using oci_pconnect on a non pooled
2024 * datasource should produce a normal connection.
2026 * When it comes to frequent shortlived DB connections like with MW
2027 * Oracle tends to s***. The problem is the driver connects to the
2028 * database reasonably fast, but establishing a session takes time and
2029 * resources. MW does not rely on session state (as it does not use
2030 * features such as package variables) so establishing a valid session
2031 * is in this case an unwanted overhead that just slows things down.
2033 * @warning EXPERIMENTAL!
2035 $wgDBOracleDRCP = false;
2038 * Other wikis on this site, can be administered from a single developer
2039 * account.
2040 * Array numeric key => database name
2042 $wgLocalDatabases = [];
2045 * If lag is higher than $wgSlaveLagWarning, show a warning in some special
2046 * pages (like watchlist). If the lag is higher than $wgSlaveLagCritical,
2047 * show a more obvious warning.
2049 $wgSlaveLagWarning = 10;
2052 * @see $wgSlaveLagWarning
2054 $wgSlaveLagCritical = 30;
2057 * Use Windows Authentication instead of $wgDBuser / $wgDBpassword for MS SQL Server
2059 $wgDBWindowsAuthentication = false;
2061 /**@}*/ # End of DB settings }
2063 /************************************************************************//**
2064 * @name Text storage
2065 * @{
2069 * We can also compress text stored in the 'text' table. If this is set on, new
2070 * revisions will be compressed on page save if zlib support is available. Any
2071 * compressed revisions will be decompressed on load regardless of this setting,
2072 * but will not be readable at all* if zlib support is not available.
2074 $wgCompressRevisions = false;
2077 * External stores allow including content
2078 * from non database sources following URL links.
2080 * Short names of ExternalStore classes may be specified in an array here:
2081 * @code
2082 * $wgExternalStores = [ "http","file","custom" ]...
2083 * @endcode
2085 * CAUTION: Access to database might lead to code execution
2087 $wgExternalStores = [];
2090 * An array of external MySQL servers.
2092 * @par Example:
2093 * Create a cluster named 'cluster1' containing three servers:
2094 * @code
2095 * $wgExternalServers = [
2096 * 'cluster1' => <array in the same format as $wgDBservers>
2097 * ];
2098 * @endcode
2100 * Used by LBFactorySimple, may be ignored if $wgLBFactoryConf is set to
2101 * another class.
2103 $wgExternalServers = [];
2106 * The place to put new revisions, false to put them in the local text table.
2107 * Part of a URL, e.g. DB://cluster1
2109 * Can be an array instead of a single string, to enable data distribution. Keys
2110 * must be consecutive integers, starting at zero.
2112 * @par Example:
2113 * @code
2114 * $wgDefaultExternalStore = [ 'DB://cluster1', 'DB://cluster2' ];
2115 * @endcode
2117 * @var array
2119 $wgDefaultExternalStore = false;
2122 * Revision text may be cached in $wgMemc to reduce load on external storage
2123 * servers and object extraction overhead for frequently-loaded revisions.
2125 * Set to 0 to disable, or number of seconds before cache expiry.
2127 $wgRevisionCacheExpiry = 86400 * 7;
2129 /** @} */ # end text storage }
2131 /************************************************************************//**
2132 * @name Performance hacks and limits
2133 * @{
2137 * Disable database-intensive features
2139 $wgMiserMode = false;
2142 * Disable all query pages if miser mode is on, not just some
2144 $wgDisableQueryPages = false;
2147 * Number of rows to cache in 'querycache' table when miser mode is on
2149 $wgQueryCacheLimit = 1000;
2152 * Number of links to a page required before it is deemed "wanted"
2154 $wgWantedPagesThreshold = 1;
2157 * Enable slow parser functions
2159 $wgAllowSlowParserFunctions = false;
2162 * Allow schema updates
2164 $wgAllowSchemaUpdates = true;
2167 * Maximum article size in kilobytes
2169 $wgMaxArticleSize = 2048;
2172 * The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to
2173 * raise PHP's memory limit if it's below this amount.
2175 $wgMemoryLimit = "50M";
2178 * The minimum amount of time that MediaWiki needs for "slow" write request,
2179 * particularly ones with multiple non-atomic writes that *should* be as
2180 * transactional as possible; MediaWiki will call set_time_limit() if needed.
2181 * @since 1.26
2183 $wgTransactionalTimeLimit = 120;
2185 /** @} */ # end performance hacks }
2187 /************************************************************************//**
2188 * @name Cache settings
2189 * @{
2193 * Directory for caching data in the local filesystem. Should not be accessible
2194 * from the web.
2196 * Note: if multiple wikis share the same localisation cache directory, they
2197 * must all have the same set of extensions. You can set a directory just for
2198 * the localisation cache using $wgLocalisationCacheConf['storeDirectory'].
2200 $wgCacheDirectory = false;
2203 * Main cache type. This should be a cache with fast access, but it may have
2204 * limited space. By default, it is disabled, since the stock database cache
2205 * is not fast enough to make it worthwhile.
2207 * The options are:
2209 * - CACHE_ANYTHING: Use anything, as long as it works
2210 * - CACHE_NONE: Do not cache
2211 * - CACHE_DB: Store cache objects in the DB
2212 * - CACHE_MEMCACHED: MemCached, must specify servers in $wgMemCachedServers
2213 * - CACHE_ACCEL: APC, APCU, XCache or WinCache
2214 * - (other): A string may be used which identifies a cache
2215 * configuration in $wgObjectCaches.
2217 * @see $wgMessageCacheType, $wgParserCacheType
2219 $wgMainCacheType = CACHE_NONE;
2222 * The cache type for storing the contents of the MediaWiki namespace. This
2223 * cache is used for a small amount of data which is expensive to regenerate.
2225 * For available types see $wgMainCacheType.
2227 $wgMessageCacheType = CACHE_ANYTHING;
2230 * The cache type for storing article HTML. This is used to store data which
2231 * is expensive to regenerate, and benefits from having plenty of storage space.
2233 * For available types see $wgMainCacheType.
2235 $wgParserCacheType = CACHE_ANYTHING;
2238 * The cache type for storing session data.
2240 * For available types see $wgMainCacheType.
2242 $wgSessionCacheType = CACHE_ANYTHING;
2245 * The cache type for storing language conversion tables,
2246 * which are used when parsing certain text and interface messages.
2248 * For available types see $wgMainCacheType.
2250 * @since 1.20
2252 $wgLanguageConverterCacheType = CACHE_ANYTHING;
2255 * Advanced object cache configuration.
2257 * Use this to define the class names and constructor parameters which are used
2258 * for the various cache types. Custom cache types may be defined here and
2259 * referenced from $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType,
2260 * or $wgLanguageConverterCacheType.
2262 * The format is an associative array where the key is a cache identifier, and
2263 * the value is an associative array of parameters. The "class" parameter is the
2264 * class name which will be used. Alternatively, a "factory" parameter may be
2265 * given, giving a callable function which will generate a suitable cache object.
2267 $wgObjectCaches = [
2268 CACHE_NONE => [ 'class' => 'EmptyBagOStuff', 'reportDupes' => false ],
2269 CACHE_DB => [ 'class' => 'SqlBagOStuff', 'loggroup' => 'SQLBagOStuff' ],
2271 CACHE_ANYTHING => [ 'factory' => 'ObjectCache::newAnything' ],
2272 CACHE_ACCEL => [ 'factory' => 'ObjectCache::getLocalServerInstance' ],
2273 CACHE_MEMCACHED => [ 'class' => 'MemcachedPhpBagOStuff', 'loggroup' => 'memcached' ],
2275 'db-replicated' => [
2276 'class' => 'ReplicatedBagOStuff',
2277 'readFactory' => [
2278 'class' => 'SqlBagOStuff',
2279 'args' => [ [ 'slaveOnly' => true ] ]
2281 'writeFactory' => [
2282 'class' => 'SqlBagOStuff',
2283 'args' => [ [ 'slaveOnly' => false ] ]
2285 'loggroup' => 'SQLBagOStuff',
2286 'reportDupes' => false
2289 'apc' => [ 'class' => 'APCBagOStuff', 'reportDupes' => false ],
2290 'apcu' => [ 'class' => 'APCUBagOStuff', 'reportDupes' => false ],
2291 'xcache' => [ 'class' => 'XCacheBagOStuff', 'reportDupes' => false ],
2292 'wincache' => [ 'class' => 'WinCacheBagOStuff', 'reportDupes' => false ],
2293 'memcached-php' => [ 'class' => 'MemcachedPhpBagOStuff', 'loggroup' => 'memcached' ],
2294 'memcached-pecl' => [ 'class' => 'MemcachedPeclBagOStuff', 'loggroup' => 'memcached' ],
2295 'hash' => [ 'class' => 'HashBagOStuff', 'reportDupes' => false ],
2299 * Main Wide-Area-Network cache type. This should be a cache with fast access,
2300 * but it may have limited space. By default, it is disabled, since the basic stock
2301 * cache is not fast enough to make it worthwhile. For single data-center setups, this can
2302 * simply be pointed to a cache in $wgWANObjectCaches that uses a local $wgObjectCaches
2303 * cache with a relayer of type EventRelayerNull.
2305 * The options are:
2306 * - false: Configure the cache using $wgMainCacheType, without using
2307 * a relayer (only matters if there are multiple data-centers)
2308 * - CACHE_NONE: Do not cache
2309 * - (other): A string may be used which identifies a cache
2310 * configuration in $wgWANObjectCaches
2311 * @since 1.26
2313 $wgMainWANCache = false;
2316 * Advanced WAN object cache configuration.
2318 * Each WAN cache wraps a registered object cache (for the local cluster)
2319 * and it must also be configured to point to a PubSub instance. Subscribers
2320 * must be configured to relay purges to the actual cache servers.
2322 * The format is an associative array where the key is a cache identifier, and
2323 * the value is an associative array of parameters. The "cacheId" parameter is
2324 * a cache identifier from $wgObjectCaches. The "channels" parameter is a map of
2325 * actions ('purge') to PubSub channels defined in $wgEventRelayerConfig.
2326 * The "loggroup" parameter controls where log events are sent.
2328 * @since 1.26
2330 $wgWANObjectCaches = [
2331 CACHE_NONE => [
2332 'class' => 'WANObjectCache',
2333 'cacheId' => CACHE_NONE,
2334 'channels' => []
2336 /* Example of a simple single data-center cache:
2337 'memcached-php' => [
2338 'class' => 'WANObjectCache',
2339 'cacheId' => 'memcached-php',
2340 'channels' => [ 'purge' => 'wancache-main-memcached-purge' ]
2346 * Verify and enforce WAN cache purges using reliable DB sources as streams.
2348 * These secondary cache purges are de-duplicated via simple cache mutexes.
2349 * This improves consistency when cache purges are lost, which becomes more likely
2350 * as more cache servers are added or if there are multiple datacenters. Only keys
2351 * related to important mutable content will be checked.
2353 * @var bool
2354 * @since 1.29
2356 $wgEnableWANCacheReaper = false;
2359 * Main object stash type. This should be a fast storage system for storing
2360 * lightweight data like hit counters and user activity. Sites with multiple
2361 * data-centers should have this use a store that replicates all writes. The
2362 * store should have enough consistency for CAS operations to be usable.
2363 * Reads outside of those needed for merge() may be eventually consistent.
2365 * The options are:
2366 * - db: Store cache objects in the DB
2367 * - (other): A string may be used which identifies a cache
2368 * configuration in $wgObjectCaches
2370 * @since 1.26
2372 $wgMainStash = 'db-replicated';
2375 * The expiry time for the parser cache, in seconds.
2376 * The default is 86400 (one day).
2378 $wgParserCacheExpireTime = 86400;
2381 * @deprecated since 1.27, session data is always stored in object cache.
2383 $wgSessionsInObjectCache = true;
2386 * The expiry time to use for session storage, in seconds.
2388 $wgObjectCacheSessionExpiry = 3600;
2391 * @deprecated since 1.27, MediaWiki\Session\SessionManager doesn't use PHP session storage.
2393 $wgSessionHandler = null;
2396 * Whether to use PHP session handling ($_SESSION and session_*() functions)
2398 * If the constant MW_NO_SESSION is defined, this is forced to 'disable'.
2400 * If the constant MW_NO_SESSION_HANDLER is defined, this is ignored and PHP
2401 * session handling will function independently of SessionHandler.
2402 * SessionHandler and PHP's session handling may attempt to override each
2403 * others' cookies.
2405 * @since 1.27
2406 * @var string
2407 * - 'enable': Integrate with PHP's session handling as much as possible.
2408 * - 'warn': Integrate but log warnings if anything changes $_SESSION.
2409 * - 'disable': Throw exceptions if PHP session handling is used.
2411 $wgPHPSessionHandling = 'enable';
2414 * Number of internal PBKDF2 iterations to use when deriving session secrets.
2416 * @since 1.28
2418 $wgSessionPbkdf2Iterations = 10001;
2421 * If enabled, will send MemCached debugging information to $wgDebugLogFile
2423 $wgMemCachedDebug = false;
2426 * The list of MemCached servers and port numbers
2428 $wgMemCachedServers = [ '127.0.0.1:11211' ];
2431 * Use persistent connections to MemCached, which are shared across multiple
2432 * requests.
2434 $wgMemCachedPersistent = false;
2437 * Read/write timeout for MemCached server communication, in microseconds.
2439 $wgMemCachedTimeout = 500000;
2442 * Set this to true to maintain a copy of the message cache on the local server.
2444 * This layer of message cache is in addition to the one configured by $wgMessageCacheType.
2446 * The local copy is put in APC. If APC is not installed, this setting does nothing.
2448 * Note that this is about the message cache, which stores interface messages
2449 * maintained as wiki pages. This is separate from the localisation cache for interface
2450 * messages provided by the software, which is configured by $wgLocalisationCacheConf.
2452 $wgUseLocalMessageCache = false;
2455 * Instead of caching everything, only cache those messages which have
2456 * been customised in the site content language. This means that
2457 * MediaWiki:Foo/ja is ignored if MediaWiki:Foo doesn't exist.
2458 * This option is probably only useful for translatewiki.net.
2460 $wgAdaptiveMessageCache = false;
2463 * Localisation cache configuration. Associative array with keys:
2464 * class: The class to use. May be overridden by extensions.
2466 * store: The location to store cache data. May be 'files', 'array', 'db' or
2467 * 'detect'. If set to "files", data will be in CDB files. If set
2468 * to "db", data will be stored to the database. If set to
2469 * "detect", files will be used if $wgCacheDirectory is set,
2470 * otherwise the database will be used.
2471 * "array" is an experimental option that uses PHP files that
2472 * store static arrays.
2474 * storeClass: The class name for the underlying storage. If set to a class
2475 * name, it overrides the "store" setting.
2477 * storeDirectory: If the store class puts its data in files, this is the
2478 * directory it will use. If this is false, $wgCacheDirectory
2479 * will be used.
2481 * manualRecache: Set this to true to disable cache updates on web requests.
2482 * Use maintenance/rebuildLocalisationCache.php instead.
2484 $wgLocalisationCacheConf = [
2485 'class' => 'LocalisationCache',
2486 'store' => 'detect',
2487 'storeClass' => false,
2488 'storeDirectory' => false,
2489 'manualRecache' => false,
2493 * Allow client-side caching of pages
2495 $wgCachePages = true;
2498 * Set this to current time to invalidate all prior cached pages. Affects both
2499 * client-side and server-side caching.
2500 * You can get the current date on your server by using the command:
2501 * @verbatim
2502 * date +%Y%m%d%H%M%S
2503 * @endverbatim
2505 $wgCacheEpoch = '20030516000000';
2508 * Directory where GitInfo will look for pre-computed cache files. If false,
2509 * $wgCacheDirectory/gitinfo will be used.
2511 $wgGitInfoCacheDirectory = false;
2514 * Bump this number when changing the global style sheets and JavaScript.
2516 * It should be appended in the query string of static CSS and JS includes,
2517 * to ensure that client-side caches do not keep obsolete copies of global
2518 * styles.
2520 $wgStyleVersion = '303';
2523 * This will cache static pages for non-logged-in users to reduce
2524 * database traffic on public sites. ResourceLoader requests to default
2525 * language and skins are cached as well as single module requests.
2527 $wgUseFileCache = false;
2530 * Depth of the subdirectory hierarchy to be created under
2531 * $wgFileCacheDirectory. The subdirectories will be named based on
2532 * the MD5 hash of the title. A value of 0 means all cache files will
2533 * be put directly into the main file cache directory.
2535 $wgFileCacheDepth = 2;
2538 * Kept for extension compatibility; see $wgParserCacheType
2539 * @deprecated since 1.26
2541 $wgEnableParserCache = true;
2544 * Append a configured value to the parser cache and the sitenotice key so
2545 * that they can be kept separate for some class of activity.
2547 $wgRenderHashAppend = '';
2550 * If on, the sidebar navigation links are cached for users with the
2551 * current language set. This can save a touch of load on a busy site
2552 * by shaving off extra message lookups.
2554 * However it is also fragile: changing the site configuration, or
2555 * having a variable $wgArticlePath, can produce broken links that
2556 * don't update as expected.
2558 $wgEnableSidebarCache = false;
2561 * Expiry time for the sidebar cache, in seconds
2563 $wgSidebarCacheExpiry = 86400;
2566 * When using the file cache, we can store the cached HTML gzipped to save disk
2567 * space. Pages will then also be served compressed to clients that support it.
2569 * Requires zlib support enabled in PHP.
2571 $wgUseGzip = false;
2574 * Clock skew or the one-second resolution of time() can occasionally cause cache
2575 * problems when the user requests two pages within a short period of time. This
2576 * variable adds a given number of seconds to vulnerable timestamps, thereby giving
2577 * a grace period.
2579 $wgClockSkewFudge = 5;
2582 * Invalidate various caches when LocalSettings.php changes. This is equivalent
2583 * to setting $wgCacheEpoch to the modification time of LocalSettings.php, as
2584 * was previously done in the default LocalSettings.php file.
2586 * On high-traffic wikis, this should be set to false, to avoid the need to
2587 * check the file modification time, and to avoid the performance impact of
2588 * unnecessary cache invalidations.
2590 $wgInvalidateCacheOnLocalSettingsChange = true;
2593 * When loading extensions through the extension registration system, this
2594 * can be used to invalidate the cache. A good idea would be to set this to
2595 * one file, you can just `touch` that one to invalidate the cache
2597 * @par Example:
2598 * @code
2599 * $wgExtensionInfoMtime = filemtime( "$IP/LocalSettings.php" );
2600 * @endcode
2602 * If set to false, the mtime for each individual JSON file will be checked,
2603 * which can be slow if a large number of extensions are being loaded.
2605 * @var int|bool
2607 $wgExtensionInfoMTime = false;
2609 /** @} */ # end of cache settings
2611 /************************************************************************//**
2612 * @name HTTP proxy (CDN) settings
2614 * Many of these settings apply to any HTTP proxy used in front of MediaWiki,
2615 * although they are referred to as Squid settings for historical reasons.
2617 * Achieving a high hit ratio with an HTTP proxy requires special
2618 * configuration. See https://www.mediawiki.org/wiki/Manual:Squid_caching for
2619 * more details.
2621 * @{
2625 * Enable/disable CDN.
2626 * See https://www.mediawiki.org/wiki/Manual:Squid_caching
2628 $wgUseSquid = false;
2631 * If you run Squid3 with ESI support, enable this (default:false):
2633 $wgUseESI = false;
2636 * Send the Key HTTP header for better caching.
2637 * See https://datatracker.ietf.org/doc/draft-fielding-http-key/ for details.
2638 * @since 1.27
2640 $wgUseKeyHeader = false;
2643 * Add X-Forwarded-Proto to the Vary and Key headers for API requests and
2644 * RSS/Atom feeds. Use this if you have an SSL termination setup
2645 * and need to split the cache between HTTP and HTTPS for API requests,
2646 * feed requests and HTTP redirect responses in order to prevent cache
2647 * pollution. This does not affect 'normal' requests to index.php other than
2648 * HTTP redirects.
2650 $wgVaryOnXFP = false;
2653 * Internal server name as known to CDN, if different.
2655 * @par Example:
2656 * @code
2657 * $wgInternalServer = 'http://yourinternal.tld:8000';
2658 * @endcode
2660 $wgInternalServer = false;
2663 * Cache TTL for the CDN sent as s-maxage (without ESI) or
2664 * Surrogate-Control (with ESI). Without ESI, you should strip
2665 * out s-maxage in the CDN config.
2667 * 18000 seconds = 5 hours, more cache hits with 2678400 = 31 days.
2669 $wgSquidMaxage = 18000;
2672 * Cache timeout for the CDN when DB replica DB lag is high
2673 * @see $wgSquidMaxage
2674 * @since 1.27
2676 $wgCdnMaxageLagged = 30;
2679 * If set, any SquidPurge call on a URL or URLs will send a second purge no less than
2680 * this many seconds later via the job queue. This requires delayed job support.
2681 * This should be safely higher than the 'max lag' value in $wgLBFactoryConf, so that
2682 * replica DB lag does not cause page to be stuck in stales states in CDN.
2684 * This also fixes race conditions in two-tiered CDN setups (e.g. cdn2 => cdn1 => MediaWiki).
2685 * If a purge for a URL reaches cdn2 before cdn1 and a request reaches cdn2 for that URL,
2686 * it will populate the response from the stale cdn1 value. When cdn1 gets the purge, cdn2
2687 * will still be stale. If the rebound purge delay is safely higher than the time to relay
2688 * a purge to all nodes, then the rebound puge will clear cdn2 after cdn1 was cleared.
2690 * @since 1.27
2692 $wgCdnReboundPurgeDelay = 0;
2695 * Cache timeout for the CDN when a response is known to be wrong or incomplete (due to load)
2696 * @see $wgSquidMaxage
2697 * @since 1.27
2699 $wgCdnMaxageSubstitute = 60;
2702 * Default maximum age for raw CSS/JS accesses
2704 * 300 seconds = 5 minutes.
2706 $wgForcedRawSMaxage = 300;
2709 * List of proxy servers to purge on changes; default port is 80. Use IP addresses.
2711 * When MediaWiki is running behind a proxy, it will trust X-Forwarded-For
2712 * headers sent/modified from these proxies when obtaining the remote IP address
2714 * For a list of trusted servers which *aren't* purged, see $wgSquidServersNoPurge.
2716 $wgSquidServers = [];
2719 * As above, except these servers aren't purged on page changes; use to set a
2720 * list of trusted proxies, etc. Supports both individual IP addresses and
2721 * CIDR blocks.
2722 * @since 1.23 Supports CIDR ranges
2724 $wgSquidServersNoPurge = [];
2727 * Whether to use a Host header in purge requests sent to the proxy servers
2728 * configured in $wgSquidServers. Set this to false to support Squid
2729 * configured in forward-proxy mode.
2731 * If this is set to true, a Host header will be sent, and only the path
2732 * component of the URL will appear on the request line, as if the request
2733 * were a non-proxy HTTP 1.1 request. Varnish only supports this style of
2734 * request. Squid supports this style of request only if reverse-proxy mode
2735 * (http_port ... accel) is enabled.
2737 * If this is set to false, no Host header will be sent, and the absolute URL
2738 * will be sent in the request line, as is the standard for an HTTP proxy
2739 * request in both HTTP 1.0 and 1.1. This style of request is not supported
2740 * by Varnish, but is supported by Squid in either configuration (forward or
2741 * reverse).
2743 * @since 1.21
2745 $wgSquidPurgeUseHostHeader = true;
2748 * Routing configuration for HTCP multicast purging. Add elements here to
2749 * enable HTCP and determine which purges are sent where. If set to an empty
2750 * array, HTCP is disabled.
2752 * Each key in this array is a regular expression to match against the purged
2753 * URL, or an empty string to match all URLs. The purged URL is matched against
2754 * the regexes in the order specified, and the first rule whose regex matches
2755 * is used, all remaining rules will thus be ignored.
2757 * @par Example configuration to send purges for upload.wikimedia.org to one
2758 * multicast group and all other purges to another:
2759 * @code
2760 * $wgHTCPRouting = [
2761 * '|^https?://upload\.wikimedia\.org|' => [
2762 * 'host' => '239.128.0.113',
2763 * 'port' => 4827,
2764 * ],
2765 * '' => [
2766 * 'host' => '239.128.0.112',
2767 * 'port' => 4827,
2768 * ],
2769 * ];
2770 * @endcode
2772 * You can also pass an array of hosts to send purges too. This is useful when
2773 * you have several multicast groups or unicast address that should receive a
2774 * given purge. Multiple hosts support was introduced in MediaWiki 1.22.
2776 * @par Example of sending purges to multiple hosts:
2777 * @code
2778 * $wgHTCPRouting = [
2779 * '' => [
2780 * // Purges to text caches using multicast
2781 * [ 'host' => '239.128.0.114', 'port' => '4827' ],
2782 * // Purges to a hardcoded list of caches
2783 * [ 'host' => '10.88.66.1', 'port' => '4827' ],
2784 * [ 'host' => '10.88.66.2', 'port' => '4827' ],
2785 * [ 'host' => '10.88.66.3', 'port' => '4827' ],
2786 * ],
2787 * ];
2788 * @endcode
2790 * @since 1.22
2792 * $wgHTCPRouting replaces $wgHTCPMulticastRouting that was introduced in 1.20.
2793 * For back compatibility purposes, whenever its array is empty
2794 * $wgHTCPMutlicastRouting will be used as a fallback if it not null.
2796 * @see $wgHTCPMulticastTTL
2798 $wgHTCPRouting = [];
2801 * HTCP multicast TTL.
2802 * @see $wgHTCPRouting
2804 $wgHTCPMulticastTTL = 1;
2807 * Should forwarded Private IPs be accepted?
2809 $wgUsePrivateIPs = false;
2811 /** @} */ # end of HTTP proxy settings
2813 /************************************************************************//**
2814 * @name Language, regional and character encoding settings
2815 * @{
2819 * Site language code. See languages/data/Names.php for languages supported by
2820 * MediaWiki out of the box. Not all languages listed there have translations,
2821 * see languages/messages/ for the list of languages with some localisation.
2823 * Warning: Don't use language codes listed in $wgDummyLanguageCodes like "no"
2824 * for Norwegian (use "nb" instead), or things will break unexpectedly.
2826 * This defines the default interface language for all users, but users can
2827 * change it in their preferences.
2829 * This also defines the language of pages in the wiki. The content is wrapped
2830 * in a html element with lang=XX attribute. This behavior can be overridden
2831 * via hooks, see Title::getPageLanguage.
2833 $wgLanguageCode = 'en';
2836 * Language cache size, or really how many languages can we handle
2837 * simultaneously without degrading to crawl speed.
2839 $wgLangObjCacheSize = 10;
2842 * Some languages need different word forms, usually for different cases.
2843 * Used in Language::convertGrammar().
2845 * @par Example:
2846 * @code
2847 * $wgGrammarForms['en']['genitive']['car'] = 'car\'s';
2848 * @endcode
2850 $wgGrammarForms = [];
2853 * Treat language links as magic connectors, not inline links
2855 $wgInterwikiMagic = true;
2858 * Hide interlanguage links from the sidebar
2860 $wgHideInterlanguageLinks = false;
2863 * List of additional interwiki prefixes that should be treated as
2864 * interlanguage links (i.e. placed in the sidebar).
2865 * Notes:
2866 * - This will not do anything unless the prefixes are defined in the interwiki
2867 * map.
2868 * - The display text for these custom interlanguage links will be fetched from
2869 * the system message "interlanguage-link-xyz" where xyz is the prefix in
2870 * this array.
2871 * - A friendly name for each site, used for tooltip text, may optionally be
2872 * placed in the system message "interlanguage-link-sitename-xyz" where xyz is
2873 * the prefix in this array.
2875 $wgExtraInterlanguageLinkPrefixes = [];
2878 * List of language names or overrides for default names in Names.php
2880 $wgExtraLanguageNames = [];
2883 * List of language codes that don't correspond to an actual language.
2884 * These codes are mostly left-offs from renames, or other legacy things.
2885 * This array makes them not appear as a selectable language on the installer,
2886 * and excludes them when running the transstat.php script.
2888 $wgDummyLanguageCodes = [
2889 'als' => 'gsw',
2890 'bat-smg' => 'sgs',
2891 'be-x-old' => 'be-tarask',
2892 'bh' => 'bho',
2893 'fiu-vro' => 'vro',
2894 'no' => 'nb',
2895 'qqq' => 'qqq', # Used for message documentation.
2896 'qqx' => 'qqx', # Used for viewing message keys.
2897 'roa-rup' => 'rup',
2898 'simple' => 'en',
2899 'zh-classical' => 'lzh',
2900 'zh-min-nan' => 'nan',
2901 'zh-yue' => 'yue',
2905 * Set this to true to replace Arabic presentation forms with their standard
2906 * forms in the U+0600-U+06FF block. This only works if $wgLanguageCode is
2907 * set to "ar".
2909 * Note that pages with titles containing presentation forms will become
2910 * inaccessible, run maintenance/cleanupTitles.php to fix this.
2912 $wgFixArabicUnicode = true;
2915 * Set this to true to replace ZWJ-based chillu sequences in Malayalam text
2916 * with their Unicode 5.1 equivalents. This only works if $wgLanguageCode is
2917 * set to "ml". Note that some clients (even new clients as of 2010) do not
2918 * support these characters.
2920 * If you enable this on an existing wiki, run maintenance/cleanupTitles.php to
2921 * fix any ZWJ sequences in existing page titles.
2923 $wgFixMalayalamUnicode = true;
2926 * Set this to always convert certain Unicode sequences to modern ones
2927 * regardless of the content language. This has a small performance
2928 * impact.
2930 * See $wgFixArabicUnicode and $wgFixMalayalamUnicode for conversion
2931 * details.
2933 * @since 1.17
2935 $wgAllUnicodeFixes = false;
2938 * Set this to eg 'ISO-8859-1' to perform character set conversion when
2939 * loading old revisions not marked with "utf-8" flag. Use this when
2940 * converting a wiki from MediaWiki 1.4 or earlier to UTF-8 without the
2941 * burdensome mass conversion of old text data.
2943 * @note This DOES NOT touch any fields other than old_text. Titles, comments,
2944 * user names, etc still must be converted en masse in the database before
2945 * continuing as a UTF-8 wiki.
2947 $wgLegacyEncoding = false;
2950 * Browser Blacklist for unicode non compliant browsers. Contains a list of
2951 * regexps : "/regexp/" matching problematic browsers. These browsers will
2952 * be served encoded unicode in the edit box instead of real unicode.
2954 $wgBrowserBlackList = [
2956 * Netscape 2-4 detection
2957 * The minor version may contain strings such as "Gold" or "SGoldC-SGI"
2958 * Lots of non-netscape user agents have "compatible", so it's useful to check for that
2959 * with a negative assertion. The [UIN] identifier specifies the level of security
2960 * in a Netscape/Mozilla browser, checking for it rules out a number of fakers.
2961 * The language string is unreliable, it is missing on NS4 Mac.
2963 * Reference: http://www.psychedelix.com/agents/index.shtml
2965 '/^Mozilla\/2\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2966 '/^Mozilla\/3\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2967 '/^Mozilla\/4\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2970 * MSIE on Mac OS 9 is teh sux0r, converts þ to <thorn>, ð to <eth>,
2971 * Þ to <THORN> and Ð to <ETH>
2973 * Known useragents:
2974 * - Mozilla/4.0 (compatible; MSIE 5.0; Mac_PowerPC)
2975 * - Mozilla/4.0 (compatible; MSIE 5.15; Mac_PowerPC)
2976 * - Mozilla/4.0 (compatible; MSIE 5.23; Mac_PowerPC)
2977 * - [...]
2979 * @link https://en.wikipedia.org/w/index.php?diff=12356041&oldid=12355864
2980 * @link https://en.wikipedia.org/wiki/Template%3AOS9
2982 '/^Mozilla\/4\.0 \(compatible; MSIE \d+\.\d+; Mac_PowerPC\)/',
2985 * Google wireless transcoder, seems to eat a lot of chars alive
2986 * https://it.wikipedia.org/w/index.php?title=Luciano_Ligabue&diff=prev&oldid=8857361
2988 '/^Mozilla\/4\.0 \(compatible; MSIE 6.0; Windows NT 5.0; Google Wireless Transcoder;\)/'
2992 * If set to true, the MediaWiki 1.4 to 1.5 schema conversion will
2993 * create stub reference rows in the text table instead of copying
2994 * the full text of all current entries from 'cur' to 'text'.
2996 * This will speed up the conversion step for large sites, but
2997 * requires that the cur table be kept around for those revisions
2998 * to remain viewable.
3000 * This option affects the updaters *only*. Any present cur stub
3001 * revisions will be readable at runtime regardless of this setting.
3003 $wgLegacySchemaConversion = false;
3006 * Enable dates like 'May 12' instead of '12 May', if the default date format
3007 * is 'dmy or mdy'.
3009 $wgAmericanDates = false;
3012 * For Hindi and Arabic use local numerals instead of Western style (0-9)
3013 * numerals in interface.
3015 $wgTranslateNumerals = true;
3018 * Translation using MediaWiki: namespace.
3019 * Interface messages will be loaded from the database.
3021 $wgUseDatabaseMessages = true;
3024 * Expiry time for the message cache key
3026 $wgMsgCacheExpiry = 86400;
3029 * Maximum entry size in the message cache, in bytes
3031 $wgMaxMsgCacheEntrySize = 10000;
3034 * Whether to enable language variant conversion.
3036 $wgDisableLangConversion = false;
3039 * Whether to enable language variant conversion for links.
3041 $wgDisableTitleConversion = false;
3044 * Default variant code, if false, the default will be the language code
3046 $wgDefaultLanguageVariant = false;
3049 * Disabled variants array of language variant conversion.
3051 * @par Example:
3052 * @code
3053 * $wgDisabledVariants[] = 'zh-mo';
3054 * $wgDisabledVariants[] = 'zh-my';
3055 * @endcode
3057 $wgDisabledVariants = [];
3060 * Like $wgArticlePath, but on multi-variant wikis, this provides a
3061 * path format that describes which parts of the URL contain the
3062 * language variant.
3064 * @par Example:
3065 * @code
3066 * $wgLanguageCode = 'sr';
3067 * $wgVariantArticlePath = '/$2/$1';
3068 * $wgArticlePath = '/wiki/$1';
3069 * @endcode
3071 * A link to /wiki/ would be redirected to /sr/Главна_страна
3073 * It is important that $wgArticlePath not overlap with possible values
3074 * of $wgVariantArticlePath.
3076 $wgVariantArticlePath = false;
3079 * Show a bar of language selection links in the user login and user
3080 * registration forms; edit the "loginlanguagelinks" message to
3081 * customise these.
3083 $wgLoginLanguageSelector = false;
3086 * When translating messages with wfMessage(), it is not always clear what
3087 * should be considered UI messages and what should be content messages.
3089 * For example, for the English Wikipedia, there should be only one 'mainpage',
3090 * so when getting the link for 'mainpage', we should treat it as site content
3091 * and call ->inContentLanguage()->text(), but for rendering the text of the
3092 * link, we call ->text(). The code behaves this way by default. However,
3093 * sites like the Wikimedia Commons do offer different versions of 'mainpage'
3094 * and the like for different languages. This array provides a way to override
3095 * the default behavior.
3097 * @par Example:
3098 * To allow language-specific main page and community
3099 * portal:
3100 * @code
3101 * $wgForceUIMsgAsContentMsg = [ 'mainpage', 'portal-url' ];
3102 * @endcode
3104 $wgForceUIMsgAsContentMsg = [];
3107 * Fake out the timezone that the server thinks it's in. This will be used for
3108 * date display and not for what's stored in the DB. Leave to null to retain
3109 * your server's OS-based timezone value.
3111 * This variable is currently used only for signature formatting and for local
3112 * time/date parser variables ({{LOCALTIME}} etc.)
3114 * Timezones can be translated by editing MediaWiki messages of type
3115 * timezone-nameinlowercase like timezone-utc.
3117 * A list of usable timezones can found at:
3118 * https://secure.php.net/manual/en/timezones.php
3120 * @par Examples:
3121 * @code
3122 * $wgLocaltimezone = 'UTC';
3123 * $wgLocaltimezone = 'GMT';
3124 * $wgLocaltimezone = 'PST8PDT';
3125 * $wgLocaltimezone = 'Europe/Sweden';
3126 * $wgLocaltimezone = 'CET';
3127 * @endcode
3129 $wgLocaltimezone = null;
3132 * Set an offset from UTC in minutes to use for the default timezone setting
3133 * for anonymous users and new user accounts.
3135 * This setting is used for most date/time displays in the software, and is
3136 * overridable in user preferences. It is *not* used for signature timestamps.
3138 * By default, this will be set to match $wgLocaltimezone.
3140 $wgLocalTZoffset = null;
3142 /** @} */ # End of language/charset settings
3144 /*************************************************************************//**
3145 * @name Output format and skin settings
3146 * @{
3150 * The default Content-Type header.
3152 $wgMimeType = 'text/html';
3155 * Previously used as content type in HTML script tags. This is now ignored since
3156 * HTML5 doesn't require a MIME type for script tags (javascript is the default).
3157 * It was also previously used by RawAction to determine the ctype query parameter
3158 * value that will result in a javascript response.
3159 * @deprecated since 1.22
3161 $wgJsMimeType = null;
3164 * The default xmlns attribute. The option to define this has been removed.
3165 * The value of this variable is no longer used by core and is set to a fixed
3166 * value in Setup.php for compatibility with extensions that depend on the value
3167 * of this variable being set. Such a dependency however is deprecated.
3168 * @deprecated since 1.22
3170 $wgXhtmlDefaultNamespace = null;
3173 * Previously used to determine if we should output an HTML5 doctype.
3174 * This is no longer used as we always output HTML5 now. For compatibility with
3175 * extensions that still check the value of this config it's value is now forced
3176 * to true by Setup.php.
3177 * @deprecated since 1.22
3179 $wgHtml5 = true;
3182 * Defines the value of the version attribute in the &lt;html&gt; tag, if any.
3184 * If your wiki uses RDFa, set it to the correct value for RDFa+HTML5.
3185 * Correct current values are 'HTML+RDFa 1.0' or 'XHTML+RDFa 1.0'.
3186 * See also https://www.w3.org/TR/rdfa-in-html/#document-conformance
3187 * @since 1.16
3189 $wgHtml5Version = null;
3192 * Temporary variable that allows HTMLForms to be rendered as tables.
3193 * Table based layouts cause various issues when designing for mobile.
3194 * This global allows skins or extensions a means to force non-table based rendering.
3195 * Setting to false forces form components to always render as div elements.
3196 * @since 1.24
3198 $wgHTMLFormAllowTableFormat = true;
3201 * Temporary variable that applies MediaWiki UI wherever it can be supported.
3202 * Temporary variable that should be removed when mediawiki ui is more
3203 * stable and change has been communicated.
3204 * @since 1.24
3206 $wgUseMediaWikiUIEverywhere = false;
3209 * Whether to label the store-to-database-and-show-to-others button in the editor
3210 * as "Save page"/"Save changes" if false (the default) or, if true, instead as
3211 * "Publish page"/"Publish changes".
3213 * @since 1.28
3215 $wgEditSubmitButtonLabelPublish = false;
3218 * Permit other namespaces in addition to the w3.org default.
3220 * Use the prefix for the key and the namespace for the value.
3222 * @par Example:
3223 * @code
3224 * $wgXhtmlNamespaces['svg'] = 'http://www.w3.org/2000/svg';
3225 * @endcode
3226 * Normally we wouldn't have to define this in the root "<html>"
3227 * element, but IE needs it there in some circumstances.
3229 * This is ignored if $wgMimeType is set to a non-XML MIME type.
3231 $wgXhtmlNamespaces = [];
3234 * Site notice shown at the top of each page
3236 * MediaWiki:Sitenotice page, which will override this. You can also
3237 * provide a separate message for logged-out users using the
3238 * MediaWiki:Anonnotice page.
3240 $wgSiteNotice = '';
3243 * If this is set, a "donate" link will appear in the sidebar. Set it to a URL.
3245 $wgSiteSupportPage = '';
3248 * Validate the overall output using tidy and refuse
3249 * to display the page if it's not valid.
3251 $wgValidateAllHtml = false;
3254 * Default skin, for new users and anonymous visitors. Registered users may
3255 * change this to any one of the other available skins in their preferences.
3257 $wgDefaultSkin = 'vector';
3260 * Fallback skin used when the skin defined by $wgDefaultSkin can't be found.
3262 * @since 1.24
3264 $wgFallbackSkin = 'fallback';
3267 * Specify the names of skins that should not be presented in the list of
3268 * available skins in user preferences. If you want to remove a skin entirely,
3269 * remove it from the skins/ directory and its entry from LocalSettings.php.
3271 $wgSkipSkins = [];
3274 * @deprecated since 1.23; use $wgSkipSkins instead
3276 $wgSkipSkin = '';
3279 * Allow user Javascript page?
3280 * This enables a lot of neat customizations, but may
3281 * increase security risk to users and server load.
3283 $wgAllowUserJs = false;
3286 * Allow user Cascading Style Sheets (CSS)?
3287 * This enables a lot of neat customizations, but may
3288 * increase security risk to users and server load.
3290 $wgAllowUserCss = false;
3293 * Allow user-preferences implemented in CSS?
3294 * This allows users to customise the site appearance to a greater
3295 * degree; disabling it will improve page load times.
3297 $wgAllowUserCssPrefs = true;
3300 * Use the site's Javascript page?
3302 $wgUseSiteJs = true;
3305 * Use the site's Cascading Style Sheets (CSS)?
3307 $wgUseSiteCss = true;
3310 * Break out of framesets. This can be used to prevent clickjacking attacks,
3311 * or to prevent external sites from framing your site with ads.
3313 $wgBreakFrames = false;
3316 * The X-Frame-Options header to send on pages sensitive to clickjacking
3317 * attacks, such as edit pages. This prevents those pages from being displayed
3318 * in a frame or iframe. The options are:
3320 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3322 * - 'SAMEORIGIN': Allow framing by pages on the same domain. This can be used
3323 * to allow framing within a trusted domain. This is insecure if there
3324 * is a page on the same domain which allows framing of arbitrary URLs.
3326 * - false: Allow all framing. This opens up the wiki to XSS attacks and thus
3327 * full compromise of local user accounts. Private wikis behind a
3328 * corporate firewall are especially vulnerable. This is not
3329 * recommended.
3331 * For extra safety, set $wgBreakFrames = true, to prevent framing on all pages,
3332 * not just edit pages.
3334 $wgEditPageFrameOptions = 'DENY';
3337 * Disallow framing of API pages directly, by setting the X-Frame-Options
3338 * header. Since the API returns CSRF tokens, allowing the results to be
3339 * framed can compromise your user's account security.
3340 * Options are:
3341 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3342 * - 'SAMEORIGIN': Allow framing by pages on the same domain.
3343 * - false: Allow all framing.
3344 * Note: $wgBreakFrames will override this for human formatted API output.
3346 $wgApiFrameOptions = 'DENY';
3349 * Disable output compression (enabled by default if zlib is available)
3351 $wgDisableOutputCompression = false;
3354 * Should we allow a broader set of characters in id attributes, per HTML5? If
3355 * not, use only HTML 4-compatible IDs. This option is for testing -- when the
3356 * functionality is ready, it will be on by default with no option.
3358 * Currently this appears to work fine in all browsers, but it's disabled by
3359 * default because it normalizes id's a bit too aggressively, breaking preexisting
3360 * content (particularly Cite). See bug 27733, bug 27694, bug 27474.
3362 $wgExperimentalHtmlIds = false;
3365 * Abstract list of footer icons for skins in place of old copyrightico and poweredbyico code
3366 * You can add new icons to the built in copyright or poweredby, or you can create
3367 * a new block. Though note that you may need to add some custom css to get good styling
3368 * of new blocks in monobook. vector and modern should work without any special css.
3370 * $wgFooterIcons itself is a key/value array.
3371 * The key is the name of a block that the icons will be wrapped in. The final id varies
3372 * by skin; Monobook and Vector will turn poweredby into f-poweredbyico while Modern
3373 * turns it into mw_poweredby.
3374 * The value is either key/value array of icons or a string.
3375 * In the key/value array the key may or may not be used by the skin but it can
3376 * be used to find the icon and unset it or change the icon if needed.
3377 * This is useful for disabling icons that are set by extensions.
3378 * The value should be either a string or an array. If it is a string it will be output
3379 * directly as html, however some skins may choose to ignore it. An array is the preferred format
3380 * for the icon, the following keys are used:
3381 * - src: An absolute url to the image to use for the icon, this is recommended
3382 * but not required, however some skins will ignore icons without an image
3383 * - srcset: optional additional-resolution images; see HTML5 specs
3384 * - url: The url to use in the a element around the text or icon, if not set an a element will
3385 * not be outputted
3386 * - alt: This is the text form of the icon, it will be displayed without an image in
3387 * skins like Modern or if src is not set, and will otherwise be used as
3388 * the alt="" for the image. This key is required.
3389 * - width and height: If the icon specified by src is not of the standard size
3390 * you can specify the size of image to use with these keys.
3391 * Otherwise they will default to the standard 88x31.
3392 * @todo Reformat documentation.
3394 $wgFooterIcons = [
3395 "copyright" => [
3396 "copyright" => [], // placeholder for the built in copyright icon
3398 "poweredby" => [
3399 "mediawiki" => [
3400 // Defaults to point at
3401 // "$wgResourceBasePath/resources/assets/poweredby_mediawiki_88x31.png"
3402 // plus srcset for 1.5x, 2x resolution variants.
3403 "src" => null,
3404 "url" => "//www.mediawiki.org/",
3405 "alt" => "Powered by MediaWiki",
3411 * Login / create account link behavior when it's possible for anonymous users
3412 * to create an account.
3413 * - true = use a combined login / create account link
3414 * - false = split login and create account into two separate links
3416 $wgUseCombinedLoginLink = false;
3419 * Display user edit counts in various prominent places.
3421 $wgEdititis = false;
3424 * Some web hosts attempt to rewrite all responses with a 404 (not found)
3425 * status code, mangling or hiding MediaWiki's output. If you are using such a
3426 * host, you should start looking for a better one. While you're doing that,
3427 * set this to false to convert some of MediaWiki's 404 responses to 200 so
3428 * that the generated error pages can be seen.
3430 * In cases where for technical reasons it is more important for MediaWiki to
3431 * send the correct status code than for the body to be transmitted intact,
3432 * this configuration variable is ignored.
3434 $wgSend404Code = true;
3437 * The $wgShowRollbackEditCount variable is used to show how many edits can be rolled back.
3438 * The numeric value of the variable controls how many edits MediaWiki will look back to
3439 * determine whether a rollback is allowed (by checking that they are all from the same author).
3440 * If the value is false or 0, the edits are not counted. Disabling this will prevent MediaWiki
3441 * from hiding some useless rollback links.
3443 * @since 1.20
3445 $wgShowRollbackEditCount = 10;
3448 * Output a <link rel="canonical"> tag on every page indicating the canonical
3449 * server which should be used, i.e. $wgServer or $wgCanonicalServer. Since
3450 * detection of the current server is unreliable, the link is sent
3451 * unconditionally.
3453 $wgEnableCanonicalServerLink = false;
3456 * When OutputHandler is used, mangle any output that contains
3457 * <cross-domain-policy>. Without this, an attacker can send their own
3458 * cross-domain policy unless it is prevented by the crossdomain.xml file at
3459 * the domain root.
3461 * @since 1.25
3463 $wgMangleFlashPolicy = true;
3465 /** @} */ # End of output format settings }
3467 /*************************************************************************//**
3468 * @name ResourceLoader settings
3469 * @{
3473 * Client-side resource modules.
3475 * Extensions should add their ResourceLoader module definitions
3476 * to the $wgResourceModules variable.
3478 * @par Example:
3479 * @code
3480 * $wgResourceModules['ext.myExtension'] = [
3481 * 'scripts' => 'myExtension.js',
3482 * 'styles' => 'myExtension.css',
3483 * 'dependencies' => [ 'jquery.cookie', 'jquery.tabIndex' ],
3484 * 'localBasePath' => __DIR__,
3485 * 'remoteExtPath' => 'MyExtension',
3486 * ];
3487 * @endcode
3489 $wgResourceModules = [];
3492 * Skin-specific styles for resource modules.
3494 * These are later added to the 'skinStyles' list of the existing module. The 'styles' list can
3495 * not be modified or disabled.
3497 * For example, here is a module "bar" and how skin Foo would provide additional styles for it.
3499 * @par Example:
3500 * @code
3501 * $wgResourceModules['bar'] = [
3502 * 'scripts' => 'resources/bar/bar.js',
3503 * 'styles' => 'resources/bar/main.css',
3504 * ];
3506 * $wgResourceModuleSkinStyles['foo'] = [
3507 * 'bar' => 'skins/Foo/bar.css',
3508 * ];
3509 * @endcode
3511 * This is mostly equivalent to:
3513 * @par Equivalent:
3514 * @code
3515 * $wgResourceModules['bar'] = [
3516 * 'scripts' => 'resources/bar/bar.js',
3517 * 'styles' => 'resources/bar/main.css',
3518 * 'skinStyles' => [
3519 * 'foo' => skins/Foo/bar.css',
3520 * ],
3521 * ];
3522 * @endcode
3524 * If the module already defines its own entry in `skinStyles` for a given skin, then
3525 * $wgResourceModuleSkinStyles is ignored.
3527 * If a module defines a `skinStyles['default']` the skin may want to extend that instead
3528 * of replacing them. This can be done using the `+` prefix.
3530 * @par Example:
3531 * @code
3532 * $wgResourceModules['bar'] = [
3533 * 'scripts' => 'resources/bar/bar.js',
3534 * 'styles' => 'resources/bar/basic.css',
3535 * 'skinStyles' => [
3536 * 'default' => 'resources/bar/additional.css',
3537 * ],
3538 * ];
3539 * // Note the '+' character:
3540 * $wgResourceModuleSkinStyles['foo'] = [
3541 * '+bar' => 'skins/Foo/bar.css',
3542 * ];
3543 * @endcode
3545 * This is mostly equivalent to:
3547 * @par Equivalent:
3548 * @code
3549 * $wgResourceModules['bar'] = [
3550 * 'scripts' => 'resources/bar/bar.js',
3551 * 'styles' => 'resources/bar/basic.css',
3552 * 'skinStyles' => [
3553 * 'default' => 'resources/bar/additional.css',
3554 * 'foo' => [
3555 * 'resources/bar/additional.css',
3556 * 'skins/Foo/bar.css',
3557 * ],
3558 * ],
3559 * ];
3560 * @endcode
3562 * In other words, as a module author, use the `styles` list for stylesheets that may not be
3563 * disabled by a skin. To provide default styles that may be extended or replaced,
3564 * use `skinStyles['default']`.
3566 * As with $wgResourceModules, paths default to being relative to the MediaWiki root.
3567 * You should always provide a localBasePath and remoteBasePath (or remoteExtPath/remoteSkinPath).
3569 * @par Example:
3570 * @code
3571 * $wgResourceModuleSkinStyles['foo'] = [
3572 * 'bar' => 'bar.css',
3573 * 'quux' => 'quux.css',
3574 * 'remoteSkinPath' => 'Foo',
3575 * 'localBasePath' => __DIR__,
3576 * ];
3577 * @endcode
3579 $wgResourceModuleSkinStyles = [];
3582 * Extensions should register foreign module sources here. 'local' is a
3583 * built-in source that is not in this array, but defined by
3584 * ResourceLoader::__construct() so that it cannot be unset.
3586 * @par Example:
3587 * @code
3588 * $wgResourceLoaderSources['foo'] = 'http://example.org/w/load.php';
3589 * @endcode
3591 $wgResourceLoaderSources = [];
3594 * The default 'remoteBasePath' value for instances of ResourceLoaderFileModule.
3595 * Defaults to $wgScriptPath.
3597 $wgResourceBasePath = null;
3600 * Maximum time in seconds to cache resources served by ResourceLoader.
3601 * Used to set last modified headers (max-age/s-maxage).
3603 * Following options to distinguish:
3604 * - versioned: Used for modules with a version, because changing version
3605 * numbers causes cache misses. This normally has a long expiry time.
3606 * - unversioned: Used for modules without a version to propagate changes
3607 * quickly to clients. Also used for modules with errors to recover quickly.
3608 * This normally has a short expiry time.
3610 * Expiry time for the options to distinguish:
3611 * - server: Squid/Varnish but also any other public proxy cache between the
3612 * client and MediaWiki.
3613 * - client: On the client side (e.g. in the browser cache).
3615 $wgResourceLoaderMaxage = [
3616 'versioned' => [
3617 'server' => 30 * 24 * 60 * 60, // 30 days
3618 'client' => 30 * 24 * 60 * 60, // 30 days
3620 'unversioned' => [
3621 'server' => 5 * 60, // 5 minutes
3622 'client' => 5 * 60, // 5 minutes
3627 * The default debug mode (on/off) for of ResourceLoader requests.
3629 * This will still be overridden when the debug URL parameter is used.
3631 $wgResourceLoaderDebug = false;
3634 * Put each statement on its own line when minifying JavaScript. This makes
3635 * debugging in non-debug mode a bit easier.
3637 * @deprecated since 1.27: Always false; no longer configurable.
3639 $wgResourceLoaderMinifierStatementsOnOwnLine = false;
3642 * Maximum line length when minifying JavaScript. This is not a hard maximum:
3643 * the minifier will try not to produce lines longer than this, but may be
3644 * forced to do so in certain cases.
3646 * @deprecated since 1.27: Always 1,000; no longer configurable.
3648 $wgResourceLoaderMinifierMaxLineLength = 1000;
3651 * Whether to ensure the mediawiki.legacy library is loaded before other modules.
3653 * @deprecated since 1.26: Always declare dependencies.
3655 $wgIncludeLegacyJavaScript = false;
3658 * Whether or not to assign configuration variables to the global window object.
3660 * If this is set to false, old code using deprecated variables will no longer
3661 * work.
3663 * @par Example of legacy code:
3664 * @code{,js}
3665 * if ( window.wgRestrictionEdit ) { ... }
3666 * @endcode
3667 * or:
3668 * @code{,js}
3669 * if ( wgIsArticle ) { ... }
3670 * @endcode
3672 * Instead, one needs to use mw.config.
3673 * @par Example using mw.config global configuration:
3674 * @code{,js}
3675 * if ( mw.config.exists('wgRestrictionEdit') ) { ... }
3676 * @endcode
3677 * or:
3678 * @code{,js}
3679 * if ( mw.config.get('wgIsArticle') ) { ... }
3680 * @endcode
3682 $wgLegacyJavaScriptGlobals = true;
3685 * If set to a positive number, ResourceLoader will not generate URLs whose
3686 * query string is more than this many characters long, and will instead use
3687 * multiple requests with shorter query strings. This degrades performance,
3688 * but may be needed if your web server has a low (less than, say 1024)
3689 * query string length limit or a low value for suhosin.get.max_value_length
3690 * that you can't increase.
3692 * If set to a negative number, ResourceLoader will assume there is no query
3693 * string length limit.
3695 * Defaults to a value based on php configuration.
3697 $wgResourceLoaderMaxQueryLength = false;
3700 * If set to true, JavaScript modules loaded from wiki pages will be parsed
3701 * prior to minification to validate it.
3703 * Parse errors will result in a JS exception being thrown during module load,
3704 * which avoids breaking other modules loaded in the same request.
3706 $wgResourceLoaderValidateJS = true;
3709 * If set to true, statically-sourced (file-backed) JavaScript resources will
3710 * be parsed for validity before being bundled up into ResourceLoader modules.
3712 * This can be helpful for development by providing better error messages in
3713 * default (non-debug) mode, but JavaScript parsing is slow and memory hungry
3714 * and may fail on large pre-bundled frameworks.
3716 $wgResourceLoaderValidateStaticJS = false;
3719 * Global LESS variables. An associative array binding variable names to
3720 * LESS code snippets representing their values.
3722 * Adding an item here is equivalent to writing `@variable: value;`
3723 * at the beginning of all your .less files, with all the consequences.
3724 * In particular, string values must be escaped and quoted.
3726 * Changes to LESS variables do not trigger cache invalidation.
3728 * If the LESS variables need to be dynamic, you can use the
3729 * ResourceLoaderGetLessVars hook (since 1.25).
3731 * @par Example:
3732 * @code
3733 * $wgResourceLoaderLESSVars = [
3734 * 'baseFontSize' => '1em',
3735 * 'smallFontSize' => '0.75em',
3736 * 'WikimediaBlue' => '#006699',
3737 * ];
3738 * @endcode
3739 * @since 1.22
3741 $wgResourceLoaderLESSVars = [
3743 * Minimum available screen width at which a device can be considered a tablet/desktop
3744 * The number is currently based on the device width of a Samsung Galaxy S5 mini and is low
3745 * enough to cover iPad (768px). Number is prone to change with new information.
3746 * @since 1.27
3748 'deviceWidthTablet' => '720px',
3752 * Default import paths for LESS modules. LESS files referenced in @import
3753 * statements will be looked up here first, and relative to the importing file
3754 * second. To avoid collisions, it's important for the LESS files in these
3755 * directories to have a common, predictable file name prefix.
3757 * Extensions need not (and should not) register paths in
3758 * $wgResourceLoaderLESSImportPaths. The import path includes the path of the
3759 * currently compiling LESS file, which allows each extension to freely import
3760 * files from its own tree.
3762 * @since 1.22
3764 $wgResourceLoaderLESSImportPaths = [
3765 "$IP/resources/src/mediawiki.less/",
3769 * Whether ResourceLoader should attempt to persist modules in localStorage on
3770 * browsers that support the Web Storage API.
3772 $wgResourceLoaderStorageEnabled = true;
3775 * Cache version for client-side ResourceLoader module storage. You can trigger
3776 * invalidation of the contents of the module store by incrementing this value.
3778 * @since 1.23
3780 $wgResourceLoaderStorageVersion = 1;
3783 * Whether to allow site-wide CSS (MediaWiki:Common.css and friends) on
3784 * restricted pages like Special:UserLogin or Special:Preferences where
3785 * JavaScript is disabled for security reasons. As it is possible to
3786 * execute JavaScript through CSS, setting this to true opens up a
3787 * potential security hole. Some sites may "skin" their wiki by using
3788 * site-wide CSS, causing restricted pages to look unstyled and different
3789 * from the rest of the site.
3791 * @since 1.25
3793 $wgAllowSiteCSSOnRestrictedPages = false;
3795 /** @} */ # End of ResourceLoader settings }
3797 /*************************************************************************//**
3798 * @name Page title and interwiki link settings
3799 * @{
3803 * Name of the project namespace. If left set to false, $wgSitename will be
3804 * used instead.
3806 $wgMetaNamespace = false;
3809 * Name of the project talk namespace.
3811 * Normally you can ignore this and it will be something like
3812 * $wgMetaNamespace . "_talk". In some languages, you may want to set this
3813 * manually for grammatical reasons.
3815 $wgMetaNamespaceTalk = false;
3818 * Additional namespaces. If the namespaces defined in Language.php and
3819 * Namespace.php are insufficient, you can create new ones here, for example,
3820 * to import Help files in other languages. You can also override the namespace
3821 * names of existing namespaces. Extensions should use the CanonicalNamespaces
3822 * hook or extension.json.
3824 * @warning Once you delete a namespace, the pages in that namespace will
3825 * no longer be accessible. If you rename it, then you can access them through
3826 * the new namespace name.
3828 * Custom namespaces should start at 100 to avoid conflicting with standard
3829 * namespaces, and should always follow the even/odd main/talk pattern.
3831 * @par Example:
3832 * @code
3833 * $wgExtraNamespaces = [
3834 * 100 => "Hilfe",
3835 * 101 => "Hilfe_Diskussion",
3836 * 102 => "Aide",
3837 * 103 => "Discussion_Aide"
3838 * ];
3839 * @endcode
3841 * @todo Add a note about maintenance/namespaceDupes.php
3843 $wgExtraNamespaces = [];
3846 * Same as above, but for namespaces with gender distinction.
3847 * Note: the default form for the namespace should also be set
3848 * using $wgExtraNamespaces for the same index.
3849 * @since 1.18
3851 $wgExtraGenderNamespaces = [];
3854 * Namespace aliases.
3856 * These are alternate names for the primary localised namespace names, which
3857 * are defined by $wgExtraNamespaces and the language file. If a page is
3858 * requested with such a prefix, the request will be redirected to the primary
3859 * name.
3861 * Set this to a map from namespace names to IDs.
3863 * @par Example:
3864 * @code
3865 * $wgNamespaceAliases = [
3866 * 'Wikipedian' => NS_USER,
3867 * 'Help' => 100,
3868 * ];
3869 * @endcode
3871 $wgNamespaceAliases = [];
3874 * Allowed title characters -- regex character class
3875 * Don't change this unless you know what you're doing
3877 * Problematic punctuation:
3878 * - []{}|# Are needed for link syntax, never enable these
3879 * - <> Causes problems with HTML escaping, don't use
3880 * - % Enabled by default, minor problems with path to query rewrite rules, see below
3881 * - + Enabled by default, but doesn't work with path to query rewrite rules,
3882 * corrupted by apache
3883 * - ? Enabled by default, but doesn't work with path to PATH_INFO rewrites
3885 * All three of these punctuation problems can be avoided by using an alias,
3886 * instead of a rewrite rule of either variety.
3888 * The problem with % is that when using a path to query rewrite rule, URLs are
3889 * double-unescaped: once by Apache's path conversion code, and again by PHP. So
3890 * %253F, for example, becomes "?". Our code does not double-escape to compensate
3891 * for this, indeed double escaping would break if the double-escaped title was
3892 * passed in the query string rather than the path. This is a minor security issue
3893 * because articles can be created such that they are hard to view or edit.
3895 * In some rare cases you may wish to remove + for compatibility with old links.
3897 * Theoretically 0x80-0x9F of ISO 8859-1 should be disallowed, but
3898 * this breaks interlanguage links
3900 $wgLegalTitleChars = " %!\"$&'()*,\\-.\\/0-9:;=?@A-Z\\\\^_`a-z~\\x80-\\xFF+";
3903 * The interwiki prefix of the current wiki, or false if it doesn't have one.
3905 * @deprecated since 1.23; use $wgLocalInterwikis instead
3907 $wgLocalInterwiki = false;
3910 * Array for multiple $wgLocalInterwiki values, in case there are several
3911 * interwiki prefixes that point to the current wiki. If $wgLocalInterwiki is
3912 * set, its value is prepended to this array, for backwards compatibility.
3914 * Note, recent changes feeds use only the first entry in this array (or
3915 * $wgLocalInterwiki, if it is set). See $wgRCFeeds
3917 $wgLocalInterwikis = [];
3920 * Expiry time for cache of interwiki table
3922 $wgInterwikiExpiry = 10800;
3925 * @name Interwiki caching settings.
3926 * @{
3930 * Interwiki cache, either as an associative array or a path to a constant
3931 * database (.cdb) file.
3933 * This data structure database is generated by the `dumpInterwiki` maintenance
3934 * script (which lives in the WikimediaMaintenance repository) and has key
3935 * formats such as the following:
3937 * - dbname:key - a simple key (e.g. enwiki:meta)
3938 * - _sitename:key - site-scope key (e.g. wiktionary:meta)
3939 * - __global:key - global-scope key (e.g. __global:meta)
3940 * - __sites:dbname - site mapping (e.g. __sites:enwiki)
3942 * Sites mapping just specifies site name, other keys provide "local url"
3943 * data layout.
3945 * @var bool|array|string
3947 $wgInterwikiCache = false;
3950 * Specify number of domains to check for messages.
3951 * - 1: Just wiki(db)-level
3952 * - 2: wiki and global levels
3953 * - 3: site levels
3955 $wgInterwikiScopes = 3;
3958 * Fallback site, if unable to resolve from cache
3960 $wgInterwikiFallbackSite = 'wiki';
3962 /** @} */ # end of Interwiki caching settings.
3965 * @name SiteStore caching settings.
3966 * @{
3970 * Specify the file location for the Sites json cache file.
3972 $wgSitesCacheFile = false;
3974 /** @} */ # end of SiteStore caching settings.
3977 * If local interwikis are set up which allow redirects,
3978 * set this regexp to restrict URLs which will be displayed
3979 * as 'redirected from' links.
3981 * @par Example:
3982 * It might look something like this:
3983 * @code
3984 * $wgRedirectSources = '!^https?://[a-z-]+\.wikipedia\.org/!';
3985 * @endcode
3987 * Leave at false to avoid displaying any incoming redirect markers.
3988 * This does not affect intra-wiki redirects, which don't change
3989 * the URL.
3991 $wgRedirectSources = false;
3994 * Set this to false to avoid forcing the first letter of links to capitals.
3996 * @warning may break links! This makes links COMPLETELY case-sensitive. Links
3997 * appearing with a capital at the beginning of a sentence will *not* go to the
3998 * same place as links in the middle of a sentence using a lowercase initial.
4000 $wgCapitalLinks = true;
4003 * @since 1.16 - This can now be set per-namespace. Some special namespaces (such
4004 * as Special, see MWNamespace::$alwaysCapitalizedNamespaces for the full list) must be
4005 * true by default (and setting them has no effect), due to various things that
4006 * require them to be so. Also, since Talk namespaces need to directly mirror their
4007 * associated content namespaces, the values for those are ignored in favor of the
4008 * subject namespace's setting. Setting for NS_MEDIA is taken automatically from
4009 * NS_FILE.
4011 * @par Example:
4012 * @code
4013 * $wgCapitalLinkOverrides[ NS_FILE ] = false;
4014 * @endcode
4016 $wgCapitalLinkOverrides = [];
4019 * Which namespaces should support subpages?
4020 * See Language.php for a list of namespaces.
4022 $wgNamespacesWithSubpages = [
4023 NS_TALK => true,
4024 NS_USER => true,
4025 NS_USER_TALK => true,
4026 NS_PROJECT => true,
4027 NS_PROJECT_TALK => true,
4028 NS_FILE_TALK => true,
4029 NS_MEDIAWIKI => true,
4030 NS_MEDIAWIKI_TALK => true,
4031 NS_TEMPLATE => true,
4032 NS_TEMPLATE_TALK => true,
4033 NS_HELP => true,
4034 NS_HELP_TALK => true,
4035 NS_CATEGORY_TALK => true
4039 * Array holding default tracking category names.
4041 * Array contains the system messages for each tracking category.
4042 * Tracking categories allow pages with certain characteristics to be tracked.
4043 * It works by adding any such page to a category automatically.
4045 * A message with the suffix '-desc' should be added as a description message
4046 * to have extra information on Special:TrackingCategories.
4048 * @deprecated since 1.25 Extensions should now register tracking categories using
4049 * the new extension registration system.
4051 * @since 1.23
4053 $wgTrackingCategories = [];
4056 * Array of namespaces which can be deemed to contain valid "content", as far
4057 * as the site statistics are concerned. Useful if additional namespaces also
4058 * contain "content" which should be considered when generating a count of the
4059 * number of articles in the wiki.
4061 $wgContentNamespaces = [ NS_MAIN ];
4064 * Array of namespaces, in addition to the talk namespaces, where signatures
4065 * (~~~~) are likely to be used. This determines whether to display the
4066 * Signature button on the edit toolbar, and may also be used by extensions.
4067 * For example, "traditional" style wikis, where content and discussion are
4068 * intermixed, could place NS_MAIN and NS_PROJECT namespaces in this array.
4070 $wgExtraSignatureNamespaces = [];
4073 * Max number of redirects to follow when resolving redirects.
4074 * 1 means only the first redirect is followed (default behavior).
4075 * 0 or less means no redirects are followed.
4077 $wgMaxRedirects = 1;
4080 * Array of invalid page redirect targets.
4081 * Attempting to create a redirect to any of the pages in this array
4082 * will make the redirect fail.
4083 * Userlogout is hard-coded, so it does not need to be listed here.
4084 * (bug 10569) Disallow Mypage and Mytalk as well.
4086 * As of now, this only checks special pages. Redirects to pages in
4087 * other namespaces cannot be invalidated by this variable.
4089 $wgInvalidRedirectTargets = [ 'Filepath', 'Mypage', 'Mytalk', 'Redirect' ];
4091 /** @} */ # End of title and interwiki settings }
4093 /************************************************************************//**
4094 * @name Parser settings
4095 * These settings configure the transformation from wikitext to HTML.
4096 * @{
4100 * Parser configuration. Associative array with the following members:
4102 * class The class name
4104 * preprocessorClass The preprocessor class. Two classes are currently available:
4105 * Preprocessor_Hash, which uses plain PHP arrays for temporary
4106 * storage, and Preprocessor_DOM, which uses the DOM module for
4107 * temporary storage. Preprocessor_DOM generally uses less memory;
4108 * the speed of the two is roughly the same.
4110 * If this parameter is not given, it uses Preprocessor_DOM if the
4111 * DOM module is available, otherwise it uses Preprocessor_Hash.
4113 * The entire associative array will be passed through to the constructor as
4114 * the first parameter. Note that only Setup.php can use this variable --
4115 * the configuration will change at runtime via $wgParser member functions, so
4116 * the contents of this variable will be out-of-date. The variable can only be
4117 * changed during LocalSettings.php, in particular, it can't be changed during
4118 * an extension setup function.
4120 $wgParserConf = [
4121 'class' => 'Parser',
4122 # 'preprocessorClass' => 'Preprocessor_Hash',
4126 * Maximum indent level of toc.
4128 $wgMaxTocLevel = 999;
4131 * A complexity limit on template expansion: the maximum number of nodes visited
4132 * by PPFrame::expand()
4134 $wgMaxPPNodeCount = 1000000;
4137 * A complexity limit on template expansion: the maximum number of elements
4138 * generated by Preprocessor::preprocessToObj(). This allows you to limit the
4139 * amount of memory used by the Preprocessor_DOM node cache: testing indicates
4140 * that each element uses about 160 bytes of memory on a 64-bit processor, so
4141 * this default corresponds to about 155 MB.
4143 * When the limit is exceeded, an exception is thrown.
4145 $wgMaxGeneratedPPNodeCount = 1000000;
4148 * Maximum recursion depth for templates within templates.
4149 * The current parser adds two levels to the PHP call stack for each template,
4150 * and xdebug limits the call stack to 100 by default. So this should hopefully
4151 * stop the parser before it hits the xdebug limit.
4153 $wgMaxTemplateDepth = 40;
4156 * @see $wgMaxTemplateDepth
4158 $wgMaxPPExpandDepth = 40;
4161 * URL schemes that should be recognized as valid by wfParseUrl().
4163 * WARNING: Do not add 'file:' to this or internal file links will be broken.
4164 * Instead, if you want to support file links, add 'file://'. The same applies
4165 * to any other protocols with the same name as a namespace. See bug #44011 for
4166 * more information.
4168 * @see wfParseUrl
4170 $wgUrlProtocols = [
4171 'bitcoin:', 'ftp://', 'ftps://', 'geo:', 'git://', 'gopher://', 'http://',
4172 'https://', 'irc://', 'ircs://', 'magnet:', 'mailto:', 'mms://', 'news:',
4173 'nntp://', 'redis://', 'sftp://', 'sip:', 'sips:', 'sms:', 'ssh://',
4174 'svn://', 'tel:', 'telnet://', 'urn:', 'worldwind://', 'xmpp:', '//'
4178 * If true, removes (by substituting) templates in signatures.
4180 $wgCleanSignatures = true;
4183 * Whether to allow inline image pointing to other websites
4185 $wgAllowExternalImages = false;
4188 * If the above is false, you can specify an exception here. Image URLs
4189 * that start with this string are then rendered, while all others are not.
4190 * You can use this to set up a trusted, simple repository of images.
4191 * You may also specify an array of strings to allow multiple sites
4193 * @par Examples:
4194 * @code
4195 * $wgAllowExternalImagesFrom = 'http://127.0.0.1/';
4196 * $wgAllowExternalImagesFrom = [ 'http://127.0.0.1/', 'http://example.com' ];
4197 * @endcode
4199 $wgAllowExternalImagesFrom = '';
4202 * If $wgAllowExternalImages is false, you can allow an on-wiki
4203 * whitelist of regular expression fragments to match the image URL
4204 * against. If the image matches one of the regular expression fragments,
4205 * The image will be displayed.
4207 * Set this to true to enable the on-wiki whitelist (MediaWiki:External image whitelist)
4208 * Or false to disable it
4210 $wgEnableImageWhitelist = true;
4213 * A different approach to the above: simply allow the "<img>" tag to be used.
4214 * This allows you to specify alt text and other attributes, copy-paste HTML to
4215 * your wiki more easily, etc. However, allowing external images in any manner
4216 * will allow anyone with editing rights to snoop on your visitors' IP
4217 * addresses and so forth, if they wanted to, by inserting links to images on
4218 * sites they control.
4220 $wgAllowImageTag = false;
4223 * Configuration for HTML postprocessing tool. Set this to a configuration
4224 * array to enable an external tool. Dave Raggett's "HTML Tidy" is typically
4225 * used. See https://www.w3.org/People/Raggett/tidy/
4227 * If this is null and $wgUseTidy is true, the deprecated configuration
4228 * parameters will be used instead.
4230 * If this is null and $wgUseTidy is false, a pure PHP fallback will be used.
4232 * Keys are:
4233 * - driver: May be:
4234 * - RaggettInternalHHVM: Use the limited-functionality HHVM extension
4235 * - RaggettInternalPHP: Use the PECL extension
4236 * - RaggettExternal: Shell out to an external binary (tidyBin)
4237 * - Html5Depurate: Use external Depurate service
4238 * - Html5Internal: Use the built-in HTML5 balancer
4240 * - tidyConfigFile: Path to configuration file for any of the Raggett drivers
4241 * - debugComment: True to add a comment to the output with warning messages
4242 * - tidyBin: For RaggettExternal, the path to the tidy binary.
4243 * - tidyCommandLine: For RaggettExternal, additional command line options.
4245 $wgTidyConfig = null;
4248 * Set this to true to use the deprecated tidy configuration parameters.
4249 * @deprecated use $wgTidyConfig
4251 $wgUseTidy = false;
4254 * The path to the tidy binary.
4255 * @deprecated Use $wgTidyConfig['tidyBin']
4257 $wgTidyBin = 'tidy';
4260 * The path to the tidy config file
4261 * @deprecated Use $wgTidyConfig['tidyConfigFile']
4263 $wgTidyConf = $IP . '/includes/tidy/tidy.conf';
4266 * The command line options to the tidy binary
4267 * @deprecated Use $wgTidyConfig['tidyCommandLine']
4269 $wgTidyOpts = '';
4272 * Set this to true to use the tidy extension
4273 * @deprecated Use $wgTidyConfig['driver']
4275 $wgTidyInternal = extension_loaded( 'tidy' );
4278 * Put tidy warnings in HTML comments
4279 * Only works for internal tidy.
4281 $wgDebugTidy = false;
4284 * Allow raw, unchecked HTML in "<html>...</html>" sections.
4285 * THIS IS VERY DANGEROUS on a publicly editable site, so USE wgGroupPermissions
4286 * TO RESTRICT EDITING to only those that you trust
4288 $wgRawHtml = false;
4291 * Set a default target for external links, e.g. _blank to pop up a new window.
4293 * This will also set the "noreferrer" and "noopener" link rel to prevent the
4294 * attack described at https://mathiasbynens.github.io/rel-noopener/ .
4295 * Some older browsers may not support these link attributes, hence
4296 * setting $wgExternalLinkTarget to _blank may represent a security risk
4297 * to some of your users.
4299 $wgExternalLinkTarget = false;
4302 * If true, external URL links in wiki text will be given the
4303 * rel="nofollow" attribute as a hint to search engines that
4304 * they should not be followed for ranking purposes as they
4305 * are user-supplied and thus subject to spamming.
4307 $wgNoFollowLinks = true;
4310 * Namespaces in which $wgNoFollowLinks doesn't apply.
4311 * See Language.php for a list of namespaces.
4313 $wgNoFollowNsExceptions = [];
4316 * If this is set to an array of domains, external links to these domain names
4317 * (or any subdomains) will not be set to rel="nofollow" regardless of the
4318 * value of $wgNoFollowLinks. For instance:
4320 * $wgNoFollowDomainExceptions = [ 'en.wikipedia.org', 'wiktionary.org', 'mediawiki.org' ];
4322 * This would add rel="nofollow" to links to de.wikipedia.org, but not
4323 * en.wikipedia.org, wiktionary.org, en.wiktionary.org, us.en.wikipedia.org,
4324 * etc.
4326 * Defaults to mediawiki.org for the links included in the software by default.
4328 $wgNoFollowDomainExceptions = [ 'mediawiki.org' ];
4331 * Allow DISPLAYTITLE to change title display
4333 $wgAllowDisplayTitle = true;
4336 * For consistency, restrict DISPLAYTITLE to text that normalizes to the same
4337 * canonical DB key. Also disallow some inline CSS rules like display: none;
4338 * which can cause the text to be hidden or unselectable.
4340 $wgRestrictDisplayTitle = true;
4343 * Maximum number of calls per parse to expensive parser functions such as
4344 * PAGESINCATEGORY.
4346 $wgExpensiveParserFunctionLimit = 100;
4349 * Preprocessor caching threshold
4350 * Setting it to 'false' will disable the preprocessor cache.
4352 $wgPreprocessorCacheThreshold = 1000;
4355 * Enable interwiki transcluding. Only when iw_trans=1 in the interwiki table.
4357 $wgEnableScaryTranscluding = false;
4360 * Expiry time for transcluded templates cached in transcache database table.
4361 * Only used $wgEnableInterwikiTranscluding is set to true.
4363 $wgTranscludeCacheExpiry = 3600;
4366 * Enable the magic links feature of automatically turning ISBN xxx,
4367 * PMID xxx, RFC xxx into links
4369 * @since 1.28
4371 $wgEnableMagicLinks = [
4372 'ISBN' => false,
4373 'PMID' => false,
4374 'RFC' => false
4377 /** @} */ # end of parser settings }
4379 /************************************************************************//**
4380 * @name Statistics
4381 * @{
4385 * Method used to determine if a page in a content namespace should be counted
4386 * as a valid article.
4388 * Redirect pages will never be counted as valid articles.
4390 * This variable can have the following values:
4391 * - 'any': all pages as considered as valid articles
4392 * - 'comma': the page must contain a comma to be considered valid
4393 * - 'link': the page must contain a [[wiki link]] to be considered valid
4395 * See also See https://www.mediawiki.org/wiki/Manual:Article_count
4397 * Retroactively changing this variable will not affect the existing count,
4398 * to update it, you will need to run the maintenance/updateArticleCount.php
4399 * script.
4401 $wgArticleCountMethod = 'link';
4404 * How many days user must be idle before he is considered inactive. Will affect
4405 * the number shown on Special:Statistics, Special:ActiveUsers, and the
4406 * {{NUMBEROFACTIVEUSERS}} magic word in wikitext.
4407 * You might want to leave this as the default value, to provide comparable
4408 * numbers between different wikis.
4410 $wgActiveUserDays = 30;
4412 /** @} */ # End of statistics }
4414 /************************************************************************//**
4415 * @name User accounts, authentication
4416 * @{
4420 * Central ID lookup providers
4421 * Key is the provider ID, value is a specification for ObjectFactory
4422 * @since 1.27
4424 $wgCentralIdLookupProviders = [
4425 'local' => [ 'class' => 'LocalIdLookup' ],
4429 * Central ID lookup provider to use by default
4430 * @var string
4432 $wgCentralIdLookupProvider = 'local';
4435 * Password policy for local wiki users. A user's effective policy
4436 * is the superset of all policy statements from the policies for the
4437 * groups where the user is a member. If more than one group policy
4438 * include the same policy statement, the value is the max() of the
4439 * values. Note true > false. The 'default' policy group is required,
4440 * and serves as the minimum policy for all users. New statements can
4441 * be added by appending to $wgPasswordPolicy['checks'].
4442 * Statements:
4443 * - MinimalPasswordLength - minimum length a user can set
4444 * - MinimumPasswordLengthToLogin - passwords shorter than this will
4445 * not be allowed to login, regardless if it is correct.
4446 * - MaximalPasswordLength - maximum length password a user is allowed
4447 * to attempt. Prevents DoS attacks with pbkdf2.
4448 * - PasswordCannotMatchUsername - Password cannot match username to
4449 * - PasswordCannotMatchBlacklist - Username/password combination cannot
4450 * match a specific, hardcoded blacklist.
4451 * - PasswordCannotBePopular - Blacklist passwords which are known to be
4452 * commonly chosen. Set to integer n to ban the top n passwords.
4453 * If you want to ban all common passwords on file, use the
4454 * PHP_INT_MAX constant.
4455 * @since 1.26
4457 $wgPasswordPolicy = [
4458 'policies' => [
4459 'bureaucrat' => [
4460 'MinimalPasswordLength' => 8,
4461 'MinimumPasswordLengthToLogin' => 1,
4462 'PasswordCannotMatchUsername' => true,
4463 'PasswordCannotBePopular' => 25,
4465 'sysop' => [
4466 'MinimalPasswordLength' => 8,
4467 'MinimumPasswordLengthToLogin' => 1,
4468 'PasswordCannotMatchUsername' => true,
4469 'PasswordCannotBePopular' => 25,
4471 'bot' => [
4472 'MinimalPasswordLength' => 8,
4473 'MinimumPasswordLengthToLogin' => 1,
4474 'PasswordCannotMatchUsername' => true,
4476 'default' => [
4477 'MinimalPasswordLength' => 1,
4478 'PasswordCannotMatchUsername' => true,
4479 'PasswordCannotMatchBlacklist' => true,
4480 'MaximalPasswordLength' => 4096,
4483 'checks' => [
4484 'MinimalPasswordLength' => 'PasswordPolicyChecks::checkMinimalPasswordLength',
4485 'MinimumPasswordLengthToLogin' => 'PasswordPolicyChecks::checkMinimumPasswordLengthToLogin',
4486 'PasswordCannotMatchUsername' => 'PasswordPolicyChecks::checkPasswordCannotMatchUsername',
4487 'PasswordCannotMatchBlacklist' => 'PasswordPolicyChecks::checkPasswordCannotMatchBlacklist',
4488 'MaximalPasswordLength' => 'PasswordPolicyChecks::checkMaximalPasswordLength',
4489 'PasswordCannotBePopular' => 'PasswordPolicyChecks::checkPopularPasswordBlacklist'
4494 * Configure AuthManager
4496 * All providers are constructed using ObjectFactory, see that for the general
4497 * structure. The array may also contain a key "sort" used to order providers:
4498 * providers are stably sorted by this value, which should be an integer
4499 * (default is 0).
4501 * Elements are:
4502 * - preauth: Array (keys ignored) of specifications for PreAuthenticationProviders
4503 * - primaryauth: Array (keys ignored) of specifications for PrimaryAuthenticationProviders
4504 * - secondaryauth: Array (keys ignored) of specifications for SecondaryAuthenticationProviders
4506 * @since 1.27
4507 * @note If this is null or empty, the value from $wgAuthManagerAutoConfig is
4508 * used instead. Local customization should generally set this variable from
4509 * scratch to the desired configuration. Extensions that want to
4510 * auto-configure themselves should use $wgAuthManagerAutoConfig instead.
4512 $wgAuthManagerConfig = null;
4515 * @see $wgAuthManagerConfig
4516 * @since 1.27
4518 $wgAuthManagerAutoConfig = [
4519 'preauth' => [
4520 MediaWiki\Auth\LegacyHookPreAuthenticationProvider::class => [
4521 'class' => MediaWiki\Auth\LegacyHookPreAuthenticationProvider::class,
4522 'sort' => 0,
4524 MediaWiki\Auth\ThrottlePreAuthenticationProvider::class => [
4525 'class' => MediaWiki\Auth\ThrottlePreAuthenticationProvider::class,
4526 'sort' => 0,
4529 'primaryauth' => [
4530 // TemporaryPasswordPrimaryAuthenticationProvider should come before
4531 // any other PasswordAuthenticationRequest-based
4532 // PrimaryAuthenticationProvider (or at least any that might return
4533 // FAIL rather than ABSTAIN for a wrong password), or password reset
4534 // won't work right. Do not remove this (or change the key) or
4535 // auto-configuration of other such providers in extensions will
4536 // probably auto-insert themselves in the wrong place.
4537 MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider::class => [
4538 'class' => MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider::class,
4539 'args' => [ [
4540 // Fall through to LocalPasswordPrimaryAuthenticationProvider
4541 'authoritative' => false,
4542 ] ],
4543 'sort' => 0,
4545 MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider::class => [
4546 'class' => MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider::class,
4547 'args' => [ [
4548 // Last one should be authoritative, or else the user will get
4549 // a less-than-helpful error message (something like "supplied
4550 // authentication info not supported" rather than "wrong
4551 // password") if it too fails.
4552 'authoritative' => true,
4553 ] ],
4554 'sort' => 100,
4557 'secondaryauth' => [
4558 MediaWiki\Auth\CheckBlocksSecondaryAuthenticationProvider::class => [
4559 'class' => MediaWiki\Auth\CheckBlocksSecondaryAuthenticationProvider::class,
4560 'sort' => 0,
4562 MediaWiki\Auth\ResetPasswordSecondaryAuthenticationProvider::class => [
4563 'class' => MediaWiki\Auth\ResetPasswordSecondaryAuthenticationProvider::class,
4564 'sort' => 100,
4566 // Linking during login is experimental, enable at your own risk - T134952
4567 // MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider::class => [
4568 // 'class' => MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider::class,
4569 // 'sort' => 100,
4570 // ],
4571 MediaWiki\Auth\EmailNotificationSecondaryAuthenticationProvider::class => [
4572 'class' => MediaWiki\Auth\EmailNotificationSecondaryAuthenticationProvider::class,
4573 'sort' => 200,
4579 * Time frame for re-authentication.
4581 * With only password-based authentication, you'd just ask the user to re-enter
4582 * their password to verify certain operations like changing the password or
4583 * changing the account's email address. But under AuthManager, the user might
4584 * not have a password (you might even have to redirect the browser to a
4585 * third-party service or something complex like that), you might want to have
4586 * both factors of a two-factor authentication, and so on. So, the options are:
4587 * - Incorporate the whole multi-step authentication flow within everything
4588 * that needs to do this.
4589 * - Consider it good if they used Special:UserLogin during this session within
4590 * the last X seconds.
4591 * - Come up with a third option.
4593 * MediaWiki currently takes the second option. This setting configures the
4594 * "X seconds".
4596 * This allows for configuring different time frames for different
4597 * "operations". The operations used in MediaWiki core include:
4598 * - LinkAccounts
4599 * - UnlinkAccount
4600 * - ChangeCredentials
4601 * - RemoveCredentials
4602 * - ChangeEmail
4604 * Additional operations may be used by extensions, either explicitly by
4605 * calling AuthManager::securitySensitiveOperationStatus(),
4606 * ApiAuthManagerHelper::securitySensitiveOperation() or
4607 * SpecialPage::checkLoginSecurityLevel(), or implicitly by overriding
4608 * SpecialPage::getLoginSecurityLevel() or by subclassing
4609 * AuthManagerSpecialPage.
4611 * The key 'default' is used if a requested operation isn't defined in the array.
4613 * @since 1.27
4614 * @var int[] operation => time in seconds. A 'default' key must always be provided.
4616 $wgReauthenticateTime = [
4617 'default' => 300,
4621 * Whether to allow security-sensitive operations when re-authentication is not possible.
4623 * If AuthManager::canAuthenticateNow() is false (e.g. the current
4624 * SessionProvider is not able to change users, such as when OAuth is in use),
4625 * AuthManager::securitySensitiveOperationStatus() cannot sensibly return
4626 * SEC_REAUTH. Setting an operation true here will have it return SEC_OK in
4627 * that case, while setting it false will have it return SEC_FAIL.
4629 * The key 'default' is used if a requested operation isn't defined in the array.
4631 * @since 1.27
4632 * @see $wgReauthenticateTime
4633 * @var bool[] operation => boolean. A 'default' key must always be provided.
4635 $wgAllowSecuritySensitiveOperationIfCannotReauthenticate = [
4636 'default' => true,
4640 * List of AuthenticationRequest class names which are not changeable through
4641 * Special:ChangeCredentials and the changeauthenticationdata API.
4642 * This is only enforced on the client level; AuthManager itself (e.g.
4643 * AuthManager::allowsAuthenticationDataChange calls) is not affected.
4644 * Class names are checked for exact match (not for subclasses).
4645 * @since 1.27
4646 * @var string[]
4648 $wgChangeCredentialsBlacklist = [
4649 \MediaWiki\Auth\TemporaryPasswordAuthenticationRequest::class
4653 * List of AuthenticationRequest class names which are not removable through
4654 * Special:RemoveCredentials and the removeauthenticationdata API.
4655 * This is only enforced on the client level; AuthManager itself (e.g.
4656 * AuthManager::allowsAuthenticationDataChange calls) is not affected.
4657 * Class names are checked for exact match (not for subclasses).
4658 * @since 1.27
4659 * @var string[]
4661 $wgRemoveCredentialsBlacklist = [
4662 \MediaWiki\Auth\PasswordAuthenticationRequest::class,
4666 * For compatibility with old installations set to false
4667 * @deprecated since 1.24 will be removed in future
4669 $wgPasswordSalt = true;
4672 * Specifies the minimal length of a user password. If set to 0, empty pass-
4673 * words are allowed.
4674 * @deprecated since 1.26, use $wgPasswordPolicy's MinimalPasswordLength.
4676 $wgMinimalPasswordLength = false;
4679 * Specifies the maximal length of a user password (T64685).
4681 * It is not recommended to make this greater than the default, as it can
4682 * allow DoS attacks by users setting really long passwords. In addition,
4683 * this should not be lowered too much, as it enforces weak passwords.
4685 * @warning Unlike other password settings, user with passwords greater than
4686 * the maximum will not be able to log in.
4687 * @deprecated since 1.26, use $wgPasswordPolicy's MaximalPasswordLength.
4689 $wgMaximalPasswordLength = false;
4692 * Specifies if users should be sent to a password-reset form on login, if their
4693 * password doesn't meet the requirements of User::isValidPassword().
4694 * @since 1.23
4696 $wgInvalidPasswordReset = true;
4699 * Default password type to use when hashing user passwords
4701 * @since 1.24
4703 $wgPasswordDefault = 'pbkdf2';
4706 * Configuration for built-in password types. Maps the password type
4707 * to an array of options. The 'class' option is the Password class to
4708 * use. All other options are class-dependent.
4710 * An advanced example:
4711 * @code
4712 * $wgPasswordConfig['bcrypt-peppered'] = [
4713 * 'class' => 'EncryptedPassword',
4714 * 'underlying' => 'bcrypt',
4715 * 'secrets' => [],
4716 * 'cipher' => MCRYPT_RIJNDAEL_256,
4717 * 'mode' => MCRYPT_MODE_CBC,
4718 * 'cost' => 5,
4719 * ];
4720 * @endcode
4722 * @since 1.24
4724 $wgPasswordConfig = [
4725 'A' => [
4726 'class' => 'MWOldPassword',
4728 'B' => [
4729 'class' => 'MWSaltedPassword',
4731 'pbkdf2-legacyA' => [
4732 'class' => 'LayeredParameterizedPassword',
4733 'types' => [
4734 'A',
4735 'pbkdf2',
4738 'pbkdf2-legacyB' => [
4739 'class' => 'LayeredParameterizedPassword',
4740 'types' => [
4741 'B',
4742 'pbkdf2',
4745 'bcrypt' => [
4746 'class' => 'BcryptPassword',
4747 'cost' => 9,
4749 'pbkdf2' => [
4750 'class' => 'Pbkdf2Password',
4751 'algo' => 'sha512',
4752 'cost' => '30000',
4753 'length' => '64',
4758 * Whether to allow password resets ("enter some identifying data, and we'll send an email
4759 * with a temporary password you can use to get back into the account") identified by
4760 * various bits of data. Setting all of these to false (or the whole variable to false)
4761 * has the effect of disabling password resets entirely
4763 $wgPasswordResetRoutes = [
4764 'username' => true,
4765 'email' => true,
4769 * Maximum number of Unicode characters in signature
4771 $wgMaxSigChars = 255;
4774 * Maximum number of bytes in username. You want to run the maintenance
4775 * script ./maintenance/checkUsernames.php once you have changed this value.
4777 $wgMaxNameChars = 255;
4780 * Array of usernames which may not be registered or logged in from
4781 * Maintenance scripts can still use these
4783 $wgReservedUsernames = [
4784 'MediaWiki default', // Default 'Main Page' and MediaWiki: message pages
4785 'Conversion script', // Used for the old Wikipedia software upgrade
4786 'Maintenance script', // Maintenance scripts which perform editing, image import script
4787 'Template namespace initialisation script', // Used in 1.2->1.3 upgrade
4788 'ScriptImporter', // Default user name used by maintenance/importSiteScripts.php
4789 'msg:double-redirect-fixer', // Automatic double redirect fix
4790 'msg:usermessage-editor', // Default user for leaving user messages
4791 'msg:proxyblocker', // For $wgProxyList and Special:Blockme (removed in 1.22)
4792 'msg:spambot_username', // Used by cleanupSpam.php
4793 'msg:autochange-username', // Used by anon category RC entries (parser functions, Lua & purges)
4797 * Settings added to this array will override the default globals for the user
4798 * preferences used by anonymous visitors and newly created accounts.
4799 * For instance, to disable editing on double clicks:
4800 * $wgDefaultUserOptions ['editondblclick'] = 0;
4802 $wgDefaultUserOptions = [
4803 'ccmeonemails' => 0,
4804 'cols' => 80, // @deprecated since 1.29 No longer used in core
4805 'date' => 'default',
4806 'diffonly' => 0,
4807 'disablemail' => 0,
4808 'editfont' => 'default',
4809 'editondblclick' => 0,
4810 'editsectiononrightclick' => 0,
4811 'enotifminoredits' => 0,
4812 'enotifrevealaddr' => 0,
4813 'enotifusertalkpages' => 1,
4814 'enotifwatchlistpages' => 1,
4815 'extendwatchlist' => 1,
4816 'fancysig' => 0,
4817 'forceeditsummary' => 0,
4818 'gender' => 'unknown',
4819 'hideminor' => 0,
4820 'hidepatrolled' => 0,
4821 'hidecategorization' => 1,
4822 'imagesize' => 2,
4823 'math' => 1,
4824 'minordefault' => 0,
4825 'newpageshidepatrolled' => 0,
4826 'nickname' => '',
4827 'norollbackdiff' => 0,
4828 'numberheadings' => 0,
4829 'previewonfirst' => 0,
4830 'previewontop' => 1,
4831 'rcdays' => 7,
4832 'rcenhancedfilters' => 0,
4833 'rclimit' => 50,
4834 'rows' => 25, // @deprecated since 1.29 No longer used in core
4835 'showhiddencats' => 0,
4836 'shownumberswatching' => 1,
4837 'showtoolbar' => 1,
4838 'skin' => false,
4839 'stubthreshold' => 0,
4840 'thumbsize' => 5,
4841 'underline' => 2,
4842 'uselivepreview' => 0,
4843 'usenewrc' => 1,
4844 'watchcreations' => 1,
4845 'watchdefault' => 1,
4846 'watchdeletion' => 0,
4847 'watchuploads' => 1,
4848 'watchlistdays' => 3.0,
4849 'watchlisthideanons' => 0,
4850 'watchlisthidebots' => 0,
4851 'watchlisthideliu' => 0,
4852 'watchlisthideminor' => 0,
4853 'watchlisthideown' => 0,
4854 'watchlisthidepatrolled' => 0,
4855 'watchlisthidecategorization' => 1,
4856 'watchlistreloadautomatically' => 0,
4857 'watchmoves' => 0,
4858 'watchrollback' => 0,
4859 'wllimit' => 250,
4860 'useeditwarning' => 1,
4861 'prefershttps' => 1,
4865 * An array of preferences to not show for the user
4867 $wgHiddenPrefs = [
4868 'rcenhancedfilters',
4872 * Characters to prevent during new account creations.
4873 * This is used in a regular expression character class during
4874 * registration (regex metacharacters like / are escaped).
4876 $wgInvalidUsernameCharacters = '@:';
4879 * Character used as a delimiter when testing for interwiki userrights
4880 * (In Special:UserRights, it is possible to modify users on different
4881 * databases if the delimiter is used, e.g. "Someuser@enwiki").
4883 * It is recommended that you have this delimiter in
4884 * $wgInvalidUsernameCharacters above, or you will not be able to
4885 * modify the user rights of those users via Special:UserRights
4887 $wgUserrightsInterwikiDelimiter = '@';
4890 * This is to let user authenticate using https when they come from http.
4891 * Based on an idea by George Herbert on wikitech-l:
4892 * https://lists.wikimedia.org/pipermail/wikitech-l/2010-October/050039.html
4893 * @since 1.17
4895 $wgSecureLogin = false;
4898 * Versioning for authentication tokens.
4900 * If non-null, this is combined with the user's secret (the user_token field
4901 * in the DB) to generate the token cookie. Changing this will invalidate all
4902 * active sessions (i.e. it will log everyone out).
4904 * @since 1.27
4905 * @var string|null
4907 $wgAuthenticationTokenVersion = null;
4910 * MediaWiki\Session\SessionProvider configuration.
4912 * Value is an array of ObjectFactory specifications for the SessionProviders
4913 * to be used. Keys in the array are ignored. Order is not significant.
4915 * @since 1.27
4917 $wgSessionProviders = [
4918 MediaWiki\Session\CookieSessionProvider::class => [
4919 'class' => MediaWiki\Session\CookieSessionProvider::class,
4920 'args' => [ [
4921 'priority' => 30,
4922 'callUserSetCookiesHook' => true,
4923 ] ],
4925 MediaWiki\Session\BotPasswordSessionProvider::class => [
4926 'class' => MediaWiki\Session\BotPasswordSessionProvider::class,
4927 'args' => [ [
4928 'priority' => 75,
4929 ] ],
4933 /** @} */ # end user accounts }
4935 /************************************************************************//**
4936 * @name User rights, access control and monitoring
4937 * @{
4941 * Number of seconds before autoblock entries expire. Default 86400 = 1 day.
4943 $wgAutoblockExpiry = 86400;
4946 * Set this to true to allow blocked users to edit their own user talk page.
4948 $wgBlockAllowsUTEdit = true;
4951 * Allow sysops to ban users from accessing Emailuser
4953 $wgSysopEmailBans = true;
4956 * Limits on the possible sizes of range blocks.
4958 * CIDR notation is hard to understand, it's easy to mistakenly assume that a
4959 * /1 is a small range and a /31 is a large range. For IPv4, setting a limit of
4960 * half the number of bits avoids such errors, and allows entire ISPs to be
4961 * blocked using a small number of range blocks.
4963 * For IPv6, RFC 3177 recommends that a /48 be allocated to every residential
4964 * customer, so range blocks larger than /64 (half the number of bits) will
4965 * plainly be required. RFC 4692 implies that a very large ISP may be
4966 * allocated a /19 if a generous HD-Ratio of 0.8 is used, so we will use that
4967 * as our limit. As of 2012, blocking the whole world would require a /4 range.
4969 $wgBlockCIDRLimit = [
4970 'IPv4' => 16, # Blocks larger than a /16 (64k addresses) will not be allowed
4971 'IPv6' => 19,
4975 * If true, blocked users will not be allowed to login. When using this with
4976 * a public wiki, the effect of logging out blocked users may actually be
4977 * avers: unless the user's address is also blocked (e.g. auto-block),
4978 * logging the user out will again allow reading and editing, just as for
4979 * anonymous visitors.
4981 $wgBlockDisablesLogin = false;
4984 * Pages anonymous user may see, set as an array of pages titles.
4986 * @par Example:
4987 * @code
4988 * $wgWhitelistRead = array ( "Main Page", "Wikipedia:Help");
4989 * @endcode
4991 * Special:Userlogin and Special:ChangePassword are always whitelisted.
4993 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
4994 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
4996 * @note Also that this will only protect _pages in the wiki_. Uploaded files
4997 * will remain readable. You can use img_auth.php to protect uploaded files,
4998 * see https://www.mediawiki.org/wiki/Manual:Image_Authorization
5000 $wgWhitelistRead = false;
5003 * Pages anonymous user may see, set as an array of regular expressions.
5005 * This function will match the regexp against the title name, which
5006 * is without underscore.
5008 * @par Example:
5009 * To whitelist [[Main Page]]:
5010 * @code
5011 * $wgWhitelistReadRegexp = [ "/Main Page/" ];
5012 * @endcode
5014 * @note Unless ^ and/or $ is specified, a regular expression might match
5015 * pages not intended to be whitelisted. The above example will also
5016 * whitelist a page named 'Security Main Page'.
5018 * @par Example:
5019 * To allow reading any page starting with 'User' regardless of the case:
5020 * @code
5021 * $wgWhitelistReadRegexp = [ "@^UsEr.*@i" ];
5022 * @endcode
5023 * Will allow both [[User is banned]] and [[User:JohnDoe]]
5025 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
5026 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
5028 $wgWhitelistReadRegexp = false;
5031 * Should editors be required to have a validated e-mail
5032 * address before being allowed to edit?
5034 $wgEmailConfirmToEdit = false;
5037 * Should MediaWiki attempt to protect user's privacy when doing redirects?
5038 * Keep this true if access counts to articles are made public.
5040 $wgHideIdentifiableRedirects = true;
5043 * Permission keys given to users in each group.
5045 * This is an array where the keys are all groups and each value is an
5046 * array of the format (right => boolean).
5048 * The second format is used to support per-namespace permissions.
5049 * Note that this feature does not fully work for all permission types.
5051 * All users are implicitly in the '*' group including anonymous visitors;
5052 * logged-in users are all implicitly in the 'user' group. These will be
5053 * combined with the permissions of all groups that a given user is listed
5054 * in in the user_groups table.
5056 * Note: Don't set $wgGroupPermissions = []; unless you know what you're
5057 * doing! This will wipe all permissions, and may mean that your users are
5058 * unable to perform certain essential tasks or access new functionality
5059 * when new permissions are introduced and default grants established.
5061 * Functionality to make pages inaccessible has not been extensively tested
5062 * for security. Use at your own risk!
5064 * This replaces $wgWhitelistAccount and $wgWhitelistEdit
5066 $wgGroupPermissions = [];
5068 /** @cond file_level_code */
5069 // Implicit group for all visitors
5070 $wgGroupPermissions['*']['createaccount'] = true;
5071 $wgGroupPermissions['*']['read'] = true;
5072 $wgGroupPermissions['*']['edit'] = true;
5073 $wgGroupPermissions['*']['createpage'] = true;
5074 $wgGroupPermissions['*']['createtalk'] = true;
5075 $wgGroupPermissions['*']['writeapi'] = true;
5076 $wgGroupPermissions['*']['editmyusercss'] = true;
5077 $wgGroupPermissions['*']['editmyuserjs'] = true;
5078 $wgGroupPermissions['*']['viewmywatchlist'] = true;
5079 $wgGroupPermissions['*']['editmywatchlist'] = true;
5080 $wgGroupPermissions['*']['viewmyprivateinfo'] = true;
5081 $wgGroupPermissions['*']['editmyprivateinfo'] = true;
5082 $wgGroupPermissions['*']['editmyoptions'] = true;
5083 # $wgGroupPermissions['*']['patrolmarks'] = false; // let anons see what was patrolled
5085 // Implicit group for all logged-in accounts
5086 $wgGroupPermissions['user']['move'] = true;
5087 $wgGroupPermissions['user']['move-subpages'] = true;
5088 $wgGroupPermissions['user']['move-rootuserpages'] = true; // can move root userpages
5089 $wgGroupPermissions['user']['move-categorypages'] = true;
5090 $wgGroupPermissions['user']['movefile'] = true;
5091 $wgGroupPermissions['user']['read'] = true;
5092 $wgGroupPermissions['user']['edit'] = true;
5093 $wgGroupPermissions['user']['createpage'] = true;
5094 $wgGroupPermissions['user']['createtalk'] = true;
5095 $wgGroupPermissions['user']['writeapi'] = true;
5096 $wgGroupPermissions['user']['upload'] = true;
5097 $wgGroupPermissions['user']['reupload'] = true;
5098 $wgGroupPermissions['user']['reupload-shared'] = true;
5099 $wgGroupPermissions['user']['minoredit'] = true;
5100 $wgGroupPermissions['user']['purge'] = true;
5101 $wgGroupPermissions['user']['sendemail'] = true;
5102 $wgGroupPermissions['user']['applychangetags'] = true;
5103 $wgGroupPermissions['user']['changetags'] = true;
5104 $wgGroupPermissions['user']['editcontentmodel'] = true;
5106 // Implicit group for accounts that pass $wgAutoConfirmAge
5107 $wgGroupPermissions['autoconfirmed']['autoconfirmed'] = true;
5108 $wgGroupPermissions['autoconfirmed']['editsemiprotected'] = true;
5110 // Users with bot privilege can have their edits hidden
5111 // from various log pages by default
5112 $wgGroupPermissions['bot']['bot'] = true;
5113 $wgGroupPermissions['bot']['autoconfirmed'] = true;
5114 $wgGroupPermissions['bot']['editsemiprotected'] = true;
5115 $wgGroupPermissions['bot']['nominornewtalk'] = true;
5116 $wgGroupPermissions['bot']['autopatrol'] = true;
5117 $wgGroupPermissions['bot']['suppressredirect'] = true;
5118 $wgGroupPermissions['bot']['apihighlimits'] = true;
5119 $wgGroupPermissions['bot']['writeapi'] = true;
5121 // Most extra permission abilities go to this group
5122 $wgGroupPermissions['sysop']['block'] = true;
5123 $wgGroupPermissions['sysop']['createaccount'] = true;
5124 $wgGroupPermissions['sysop']['delete'] = true;
5125 // can be separately configured for pages with > $wgDeleteRevisionsLimit revs
5126 $wgGroupPermissions['sysop']['bigdelete'] = true;
5127 // can view deleted history entries, but not see or restore the text
5128 $wgGroupPermissions['sysop']['deletedhistory'] = true;
5129 // can view deleted revision text
5130 $wgGroupPermissions['sysop']['deletedtext'] = true;
5131 $wgGroupPermissions['sysop']['undelete'] = true;
5132 $wgGroupPermissions['sysop']['editinterface'] = true;
5133 $wgGroupPermissions['sysop']['editusercss'] = true;
5134 $wgGroupPermissions['sysop']['edituserjs'] = true;
5135 $wgGroupPermissions['sysop']['import'] = true;
5136 $wgGroupPermissions['sysop']['importupload'] = true;
5137 $wgGroupPermissions['sysop']['move'] = true;
5138 $wgGroupPermissions['sysop']['move-subpages'] = true;
5139 $wgGroupPermissions['sysop']['move-rootuserpages'] = true;
5140 $wgGroupPermissions['sysop']['move-categorypages'] = true;
5141 $wgGroupPermissions['sysop']['patrol'] = true;
5142 $wgGroupPermissions['sysop']['autopatrol'] = true;
5143 $wgGroupPermissions['sysop']['protect'] = true;
5144 $wgGroupPermissions['sysop']['editprotected'] = true;
5145 $wgGroupPermissions['sysop']['rollback'] = true;
5146 $wgGroupPermissions['sysop']['upload'] = true;
5147 $wgGroupPermissions['sysop']['reupload'] = true;
5148 $wgGroupPermissions['sysop']['reupload-shared'] = true;
5149 $wgGroupPermissions['sysop']['unwatchedpages'] = true;
5150 $wgGroupPermissions['sysop']['autoconfirmed'] = true;
5151 $wgGroupPermissions['sysop']['editsemiprotected'] = true;
5152 $wgGroupPermissions['sysop']['ipblock-exempt'] = true;
5153 $wgGroupPermissions['sysop']['blockemail'] = true;
5154 $wgGroupPermissions['sysop']['markbotedits'] = true;
5155 $wgGroupPermissions['sysop']['apihighlimits'] = true;
5156 $wgGroupPermissions['sysop']['browsearchive'] = true;
5157 $wgGroupPermissions['sysop']['noratelimit'] = true;
5158 $wgGroupPermissions['sysop']['movefile'] = true;
5159 $wgGroupPermissions['sysop']['unblockself'] = true;
5160 $wgGroupPermissions['sysop']['suppressredirect'] = true;
5161 # $wgGroupPermissions['sysop']['pagelang'] = true;
5162 # $wgGroupPermissions['sysop']['upload_by_url'] = true;
5163 $wgGroupPermissions['sysop']['mergehistory'] = true;
5164 $wgGroupPermissions['sysop']['managechangetags'] = true;
5165 $wgGroupPermissions['sysop']['deletechangetags'] = true;
5167 // Permission to change users' group assignments
5168 $wgGroupPermissions['bureaucrat']['userrights'] = true;
5169 $wgGroupPermissions['bureaucrat']['noratelimit'] = true;
5170 // Permission to change users' groups assignments across wikis
5171 # $wgGroupPermissions['bureaucrat']['userrights-interwiki'] = true;
5172 // Permission to export pages including linked pages regardless of $wgExportMaxLinkDepth
5173 # $wgGroupPermissions['bureaucrat']['override-export-depth'] = true;
5175 # $wgGroupPermissions['sysop']['deletelogentry'] = true;
5176 # $wgGroupPermissions['sysop']['deleterevision'] = true;
5177 // To hide usernames from users and Sysops
5178 # $wgGroupPermissions['suppress']['hideuser'] = true;
5179 // To hide revisions/log items from users and Sysops
5180 # $wgGroupPermissions['suppress']['suppressrevision'] = true;
5181 // To view revisions/log items hidden from users and Sysops
5182 # $wgGroupPermissions['suppress']['viewsuppressed'] = true;
5183 // For private suppression log access
5184 # $wgGroupPermissions['suppress']['suppressionlog'] = true;
5187 * The developer group is deprecated, but can be activated if need be
5188 * to use the 'lockdb' and 'unlockdb' special pages. Those require
5189 * that a lock file be defined and creatable/removable by the web
5190 * server.
5192 # $wgGroupPermissions['developer']['siteadmin'] = true;
5194 /** @endcond */
5197 * Permission keys revoked from users in each group.
5199 * This acts the same way as wgGroupPermissions above, except that
5200 * if the user is in a group here, the permission will be removed from them.
5202 * Improperly setting this could mean that your users will be unable to perform
5203 * certain essential tasks, so use at your own risk!
5205 $wgRevokePermissions = [];
5208 * Implicit groups, aren't shown on Special:Listusers or somewhere else
5210 $wgImplicitGroups = [ '*', 'user', 'autoconfirmed' ];
5213 * A map of group names that the user is in, to group names that those users
5214 * are allowed to add or revoke.
5216 * Setting the list of groups to add or revoke to true is equivalent to "any
5217 * group".
5219 * @par Example:
5220 * To allow sysops to add themselves to the "bot" group:
5221 * @code
5222 * $wgGroupsAddToSelf = [ 'sysop' => [ 'bot' ] ];
5223 * @endcode
5225 * @par Example:
5226 * Implicit groups may be used for the source group, for instance:
5227 * @code
5228 * $wgGroupsRemoveFromSelf = [ '*' => true ];
5229 * @endcode
5230 * This allows users in the '*' group (i.e. any user) to remove themselves from
5231 * any group that they happen to be in.
5233 $wgGroupsAddToSelf = [];
5236 * @see $wgGroupsAddToSelf
5238 $wgGroupsRemoveFromSelf = [];
5241 * Set of available actions that can be restricted via action=protect
5242 * You probably shouldn't change this.
5243 * Translated through restriction-* messages.
5244 * Title::getRestrictionTypes() will remove restrictions that are not
5245 * applicable to a specific title (create and upload)
5247 $wgRestrictionTypes = [ 'create', 'edit', 'move', 'upload' ];
5250 * Rights which can be required for each protection level (via action=protect)
5252 * You can add a new protection level that requires a specific
5253 * permission by manipulating this array. The ordering of elements
5254 * dictates the order on the protection form's lists.
5256 * - '' will be ignored (i.e. unprotected)
5257 * - 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility
5258 * - 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility
5260 $wgRestrictionLevels = [ '', 'autoconfirmed', 'sysop' ];
5263 * Restriction levels that can be used with cascading protection
5265 * A page can only be protected with cascading protection if the
5266 * requested restriction level is included in this array.
5268 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
5269 * 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility.
5271 $wgCascadingRestrictionLevels = [ 'sysop' ];
5274 * Restriction levels that should be considered "semiprotected"
5276 * Certain places in the interface recognize a dichotomy between "protected"
5277 * and "semiprotected", without further distinguishing the specific levels. In
5278 * general, if anyone can be eligible to edit a protection level merely by
5279 * reaching some condition in $wgAutopromote, it should probably be considered
5280 * "semiprotected".
5282 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
5283 * 'sysop' is not changed, since it really shouldn't be here.
5285 $wgSemiprotectedRestrictionLevels = [ 'autoconfirmed' ];
5288 * Set the minimum permissions required to edit pages in each
5289 * namespace. If you list more than one permission, a user must
5290 * have all of them to edit pages in that namespace.
5292 * @note NS_MEDIAWIKI is implicitly restricted to 'editinterface'.
5294 $wgNamespaceProtection = [];
5297 * Pages in namespaces in this array can not be used as templates.
5299 * Elements MUST be numeric namespace ids, you can safely use the MediaWiki
5300 * namespaces constants (NS_USER, NS_MAIN...).
5302 * Among other things, this may be useful to enforce read-restrictions
5303 * which may otherwise be bypassed by using the template mechanism.
5305 $wgNonincludableNamespaces = [];
5308 * Number of seconds an account is required to age before it's given the
5309 * implicit 'autoconfirm' group membership. This can be used to limit
5310 * privileges of new accounts.
5312 * Accounts created by earlier versions of the software may not have a
5313 * recorded creation date, and will always be considered to pass the age test.
5315 * When left at 0, all registered accounts will pass.
5317 * @par Example:
5318 * Set automatic confirmation to 10 minutes (which is 600 seconds):
5319 * @code
5320 * $wgAutoConfirmAge = 600; // ten minutes
5321 * @endcode
5322 * Set age to one day:
5323 * @code
5324 * $wgAutoConfirmAge = 3600*24; // one day
5325 * @endcode
5327 $wgAutoConfirmAge = 0;
5330 * Number of edits an account requires before it is autoconfirmed.
5331 * Passing both this AND the time requirement is needed. Example:
5333 * @par Example:
5334 * @code
5335 * $wgAutoConfirmCount = 50;
5336 * @endcode
5338 $wgAutoConfirmCount = 0;
5341 * Array containing the conditions of automatic promotion of a user to specific groups.
5343 * The basic syntax for `$wgAutopromote` is:
5345 * $wgAutopromote = array(
5346 * 'groupname' => cond,
5347 * 'group2' => cond2,
5348 * );
5350 * A `cond` may be:
5351 * - a single condition without arguments:
5352 * Note that Autopromote wraps a single non-array value into an array
5353 * e.g. `APCOND_EMAILCONFIRMED` OR
5354 * array( `APCOND_EMAILCONFIRMED` )
5355 * - a single condition with arguments:
5356 * e.g. `array( APCOND_EDITCOUNT, 100 )`
5357 * - a set of conditions:
5358 * e.g. `array( 'operand', cond1, cond2, ... )`
5360 * When constructing a set of conditions, the following conditions are available:
5361 * - `&` (**AND**):
5362 * promote if user matches **ALL** conditions
5363 * - `|` (**OR**):
5364 * promote if user matches **ANY** condition
5365 * - `^` (**XOR**):
5366 * promote if user matches **ONLY ONE OF THE CONDITIONS**
5367 * - `!` (**NOT**):
5368 * promote if user matces **NO** condition
5369 * - array( APCOND_EMAILCONFIRMED ):
5370 * true if user has a confirmed e-mail
5371 * - array( APCOND_EDITCOUNT, number of edits ):
5372 * true if user has the at least the number of edits as the passed parameter
5373 * - array( APCOND_AGE, seconds since registration ):
5374 * true if the length of time since the user created his/her account
5375 * is at least the same length of time as the passed parameter
5376 * - array( APCOND_AGE_FROM_EDIT, seconds since first edit ):
5377 * true if the length of time since the user made his/her first edit
5378 * is at least the same length of time as the passed parameter
5379 * - array( APCOND_INGROUPS, group1, group2, ... ):
5380 * true if the user is a member of each of the passed groups
5381 * - array( APCOND_ISIP, ip ):
5382 * true if the user has the passed IP address
5383 * - array( APCOND_IPINRANGE, range ):
5384 * true if the user has an IP address in the range of the passed parameter
5385 * - array( APCOND_BLOCKED ):
5386 * true if the user is blocked
5387 * - array( APCOND_ISBOT ):
5388 * true if the user is a bot
5389 * - similar constructs can be defined by extensions
5391 * The sets of conditions are evaluated recursively, so you can use nested sets of conditions
5392 * linked by operands.
5394 * Note that if $wgEmailAuthentication is disabled, APCOND_EMAILCONFIRMED will be true for any
5395 * user who has provided an e-mail address.
5397 $wgAutopromote = [
5398 'autoconfirmed' => [ '&',
5399 [ APCOND_EDITCOUNT, &$wgAutoConfirmCount ],
5400 [ APCOND_AGE, &$wgAutoConfirmAge ],
5405 * Automatically add a usergroup to any user who matches certain conditions.
5407 * Does not add the user to the group again if it has been removed.
5408 * Also, does not remove the group if the user no longer meets the criteria.
5410 * The format is:
5411 * @code
5412 * [ event => criteria, ... ]
5413 * @endcode
5414 * Where event is either:
5415 * - 'onEdit' (when user edits)
5417 * Criteria has the same format as $wgAutopromote
5419 * @see $wgAutopromote
5420 * @since 1.18
5422 $wgAutopromoteOnce = [
5423 'onEdit' => [],
5427 * Put user rights log entries for autopromotion in recent changes?
5428 * @since 1.18
5430 $wgAutopromoteOnceLogInRC = true;
5433 * $wgAddGroups and $wgRemoveGroups can be used to give finer control over who
5434 * can assign which groups at Special:Userrights.
5436 * @par Example:
5437 * Bureaucrats can add any group:
5438 * @code
5439 * $wgAddGroups['bureaucrat'] = true;
5440 * @endcode
5441 * Bureaucrats can only remove bots and sysops:
5442 * @code
5443 * $wgRemoveGroups['bureaucrat'] = [ 'bot', 'sysop' ];
5444 * @endcode
5445 * Sysops can make bots:
5446 * @code
5447 * $wgAddGroups['sysop'] = [ 'bot' ];
5448 * @endcode
5449 * Sysops can disable other sysops in an emergency, and disable bots:
5450 * @code
5451 * $wgRemoveGroups['sysop'] = [ 'sysop', 'bot' ];
5452 * @endcode
5454 $wgAddGroups = [];
5457 * @see $wgAddGroups
5459 $wgRemoveGroups = [];
5462 * A list of available rights, in addition to the ones defined by the core.
5463 * For extensions only.
5465 $wgAvailableRights = [];
5468 * Optional to restrict deletion of pages with higher revision counts
5469 * to users with the 'bigdelete' permission. (Default given to sysops.)
5471 $wgDeleteRevisionsLimit = 0;
5474 * The maximum number of edits a user can have and
5475 * can still be hidden by users with the hideuser permission.
5476 * This is limited for performance reason.
5477 * Set to false to disable the limit.
5478 * @since 1.23
5480 $wgHideUserContribLimit = 1000;
5483 * Number of accounts each IP address may create per specified period(s).
5485 * @par Example:
5486 * @code
5487 * $wgAccountCreationThrottle = [
5488 * // no more than 100 per month
5490 * 'count' => 100,
5491 * 'seconds' => 30*86400,
5492 * ],
5493 * // no more than 10 per day
5495 * 'count' => 10,
5496 * 'seconds' => 86400,
5497 * ],
5498 * ];
5499 * @endcode
5501 * @warning Requires $wgMainCacheType to be enabled
5503 $wgAccountCreationThrottle = [ [
5504 'count' => 0,
5505 'seconds' => 86400,
5506 ] ];
5509 * Edits matching these regular expressions in body text
5510 * will be recognised as spam and rejected automatically.
5512 * There's no administrator override on-wiki, so be careful what you set. :)
5513 * May be an array of regexes or a single string for backwards compatibility.
5515 * @see https://en.wikipedia.org/wiki/Regular_expression
5517 * @note Each regex needs a beginning/end delimiter, eg: # or /
5519 $wgSpamRegex = [];
5522 * Same as the above except for edit summaries
5524 $wgSummarySpamRegex = [];
5527 * Whether to use DNS blacklists in $wgDnsBlacklistUrls to check for open
5528 * proxies
5529 * @since 1.16
5531 $wgEnableDnsBlacklist = false;
5534 * List of DNS blacklists to use, if $wgEnableDnsBlacklist is true.
5536 * This is an array of either a URL or an array with the URL and a key (should
5537 * the blacklist require a key).
5539 * @par Example:
5540 * @code
5541 * $wgDnsBlacklistUrls = [
5542 * // String containing URL
5543 * 'http.dnsbl.sorbs.net.',
5544 * // Array with URL and key, for services that require a key
5545 * [ 'dnsbl.httpbl.net.', 'mykey' ],
5546 * // Array with just the URL. While this works, it is recommended that you
5547 * // just use a string as shown above
5548 * [ 'opm.tornevall.org.' ]
5549 * ];
5550 * @endcode
5552 * @note You should end the domain name with a . to avoid searching your
5553 * eventual domain search suffixes.
5554 * @since 1.16
5556 $wgDnsBlacklistUrls = [ 'http.dnsbl.sorbs.net.' ];
5559 * Proxy whitelist, list of addresses that are assumed to be non-proxy despite
5560 * what the other methods might say.
5562 $wgProxyWhitelist = [];
5565 * IP ranges that should be considered soft-blocked (anon-only, account
5566 * creation allowed). The intent is to use this to prevent anonymous edits from
5567 * shared resources such as Wikimedia Labs.
5568 * @since 1.29
5569 * @var string[]
5571 $wgSoftBlockRanges = [];
5574 * Whether to look at the X-Forwarded-For header's list of (potentially spoofed)
5575 * IPs and apply IP blocks to them. This allows for IP blocks to work with correctly-configured
5576 * (transparent) proxies without needing to block the proxies themselves.
5578 $wgApplyIpBlocksToXff = false;
5581 * Simple rate limiter options to brake edit floods.
5583 * Maximum number actions allowed in the given number of seconds; after that
5584 * the violating client receives HTTP 500 error pages until the period
5585 * elapses.
5587 * @par Example:
5588 * Limits per configured per action and then type of users.
5589 * @code
5590 * $wgRateLimits = [
5591 * 'edit' => [
5592 * 'anon' => [ x, y ], // any and all anonymous edits (aggregate)
5593 * 'user' => [ x, y ], // each logged-in user
5594 * 'newbie' => [ x, y ], // each new autoconfirmed accounts; overrides 'user'
5595 * 'ip' => [ x, y ], // each anon and recent account
5596 * 'subnet' => [ x, y ], // ... within a /24 subnet in IPv4 or /64 in IPv6
5597 * 'groupName' => [ x, y ], // by group membership
5599 * ];
5600 * @endcode
5602 * @par Normally, the 'noratelimit' right allows a user to bypass any rate
5603 * limit checks. This can be disabled on a per-action basis by setting the
5604 * special '&can-bypass' key to false in that action's configuration.
5605 * @code
5606 * $wgRateLimits = [
5607 * 'some-action' => [
5608 * '&can-bypass' => false,
5609 * 'user' => [ x, y ],
5610 * ];
5611 * @endcode
5613 * @warning Requires that $wgMainCacheType is set to something persistent
5615 $wgRateLimits = [
5616 // Page edits
5617 'edit' => [
5618 'ip' => [ 8, 60 ],
5619 'newbie' => [ 8, 60 ],
5621 // Page moves
5622 'move' => [
5623 'newbie' => [ 2, 120 ],
5624 'user' => [ 8, 60 ],
5626 // File uploads
5627 'upload' => [
5628 'ip' => [ 8, 60 ],
5629 'newbie' => [ 8, 60 ],
5631 // Page rollbacks
5632 'rollback' => [
5633 'user' => [ 10, 60 ],
5634 'newbie' => [ 5, 120 ]
5636 // Triggering password resets emails
5637 'mailpassword' => [
5638 'ip' => [ 5, 3600 ],
5640 // Emailing other users using MediaWiki
5641 'emailuser' => [
5642 'ip' => [ 5, 86400 ],
5643 'newbie' => [ 5, 86400 ],
5644 'user' => [ 20, 86400 ],
5646 // Purging pages
5647 'purge' => [
5648 'ip' => [ 30, 60 ],
5649 'user' => [ 30, 60 ],
5651 // Purges of link tables
5652 'linkpurge' => [
5653 'ip' => [ 30, 60 ],
5654 'user' => [ 30, 60 ],
5656 // Files rendered via thumb.php or thumb_handler.php
5657 'renderfile' => [
5658 'ip' => [ 700, 30 ],
5659 'user' => [ 700, 30 ],
5661 // Same as above but for non-standard thumbnails
5662 'renderfile-nonstandard' => [
5663 'ip' => [ 70, 30 ],
5664 'user' => [ 70, 30 ],
5666 // Stashing edits into cache before save
5667 'stashedit' => [
5668 'ip' => [ 30, 60 ],
5669 'newbie' => [ 30, 60 ],
5671 // Adding or removing change tags
5672 'changetag' => [
5673 'ip' => [ 8, 60 ],
5674 'newbie' => [ 8, 60 ],
5676 // Changing the content model of a page
5677 'editcontentmodel' => [
5678 'newbie' => [ 2, 120 ],
5679 'user' => [ 8, 60 ],
5684 * Array of IPs which should be excluded from rate limits.
5685 * This may be useful for whitelisting NAT gateways for conferences, etc.
5687 $wgRateLimitsExcludedIPs = [];
5690 * Log IP addresses in the recentchanges table; can be accessed only by
5691 * extensions (e.g. CheckUser) or a DB admin
5692 * Used for retroactive autoblocks
5694 $wgPutIPinRC = true;
5697 * Integer defining default number of entries to show on
5698 * special pages which are query-pages such as Special:Whatlinkshere.
5700 $wgQueryPageDefaultLimit = 50;
5703 * Limit password attempts to X attempts per Y seconds per IP per account.
5705 * Value is an array of arrays. Each sub-array must have a key for count
5706 * (ie count of how many attempts before throttle) and a key for seconds.
5707 * If the key 'allIPs' (case sensitive) is present, then the limit is
5708 * just per account instead of per IP per account.
5710 * @since 1.27 allIps support and multiple limits added in 1.27. Prior
5711 * to 1.27 this only supported having a single throttle.
5712 * @warning Requires $wgMainCacheType to be enabled
5714 $wgPasswordAttemptThrottle = [
5715 // Short term limit
5716 [ 'count' => 5, 'seconds' => 300 ],
5717 // Long term limit. We need to balance the risk
5718 // of somebody using this as a DoS attack to lock someone
5719 // out of their account, and someone doing a brute force attack.
5720 [ 'count' => 150, 'seconds' => 60*60*48 ],
5724 * @var Array Map of (grant => right => boolean)
5725 * Users authorize consumers (like Apps) to act on their behalf but only with
5726 * a subset of the user's normal account rights (signed off on by the user).
5727 * The possible rights to grant to a consumer are bundled into groups called
5728 * "grants". Each grant defines some rights it lets consumers inherit from the
5729 * account they may act on behalf of. Note that a user granting a right does
5730 * nothing if that user does not actually have that right to begin with.
5731 * @since 1.27
5733 $wgGrantPermissions = [];
5735 // @TODO: clean up grants
5736 // @TODO: auto-include read/editsemiprotected rights?
5738 $wgGrantPermissions['basic']['autoconfirmed'] = true;
5739 $wgGrantPermissions['basic']['autopatrol'] = true;
5740 $wgGrantPermissions['basic']['editsemiprotected'] = true;
5741 $wgGrantPermissions['basic']['ipblock-exempt'] = true;
5742 $wgGrantPermissions['basic']['nominornewtalk'] = true;
5743 $wgGrantPermissions['basic']['patrolmarks'] = true;
5744 $wgGrantPermissions['basic']['purge'] = true;
5745 $wgGrantPermissions['basic']['read'] = true;
5746 $wgGrantPermissions['basic']['skipcaptcha'] = true;
5747 $wgGrantPermissions['basic']['writeapi'] = true;
5749 $wgGrantPermissions['highvolume']['bot'] = true;
5750 $wgGrantPermissions['highvolume']['apihighlimits'] = true;
5751 $wgGrantPermissions['highvolume']['noratelimit'] = true;
5752 $wgGrantPermissions['highvolume']['markbotedits'] = true;
5754 $wgGrantPermissions['editpage']['edit'] = true;
5755 $wgGrantPermissions['editpage']['minoredit'] = true;
5756 $wgGrantPermissions['editpage']['applychangetags'] = true;
5757 $wgGrantPermissions['editpage']['changetags'] = true;
5759 $wgGrantPermissions['editprotected'] = $wgGrantPermissions['editpage'];
5760 $wgGrantPermissions['editprotected']['editprotected'] = true;
5762 $wgGrantPermissions['editmycssjs'] = $wgGrantPermissions['editpage'];
5763 $wgGrantPermissions['editmycssjs']['editmyusercss'] = true;
5764 $wgGrantPermissions['editmycssjs']['editmyuserjs'] = true;
5766 $wgGrantPermissions['editmyoptions']['editmyoptions'] = true;
5768 $wgGrantPermissions['editinterface'] = $wgGrantPermissions['editpage'];
5769 $wgGrantPermissions['editinterface']['editinterface'] = true;
5770 $wgGrantPermissions['editinterface']['editusercss'] = true;
5771 $wgGrantPermissions['editinterface']['edituserjs'] = true;
5773 $wgGrantPermissions['createeditmovepage'] = $wgGrantPermissions['editpage'];
5774 $wgGrantPermissions['createeditmovepage']['createpage'] = true;
5775 $wgGrantPermissions['createeditmovepage']['createtalk'] = true;
5776 $wgGrantPermissions['createeditmovepage']['move'] = true;
5777 $wgGrantPermissions['createeditmovepage']['move-rootuserpages'] = true;
5778 $wgGrantPermissions['createeditmovepage']['move-subpages'] = true;
5779 $wgGrantPermissions['createeditmovepage']['move-categorypages'] = true;
5781 $wgGrantPermissions['uploadfile']['upload'] = true;
5782 $wgGrantPermissions['uploadfile']['reupload-own'] = true;
5784 $wgGrantPermissions['uploadeditmovefile'] = $wgGrantPermissions['uploadfile'];
5785 $wgGrantPermissions['uploadeditmovefile']['reupload'] = true;
5786 $wgGrantPermissions['uploadeditmovefile']['reupload-shared'] = true;
5787 $wgGrantPermissions['uploadeditmovefile']['upload_by_url'] = true;
5788 $wgGrantPermissions['uploadeditmovefile']['movefile'] = true;
5789 $wgGrantPermissions['uploadeditmovefile']['suppressredirect'] = true;
5791 $wgGrantPermissions['patrol']['patrol'] = true;
5793 $wgGrantPermissions['rollback']['rollback'] = true;
5795 $wgGrantPermissions['blockusers']['block'] = true;
5796 $wgGrantPermissions['blockusers']['blockemail'] = true;
5798 $wgGrantPermissions['viewdeleted']['browsearchive'] = true;
5799 $wgGrantPermissions['viewdeleted']['deletedhistory'] = true;
5800 $wgGrantPermissions['viewdeleted']['deletedtext'] = true;
5802 $wgGrantPermissions['viewrestrictedlogs']['suppressionlog'] = true;
5804 $wgGrantPermissions['delete'] = $wgGrantPermissions['editpage'] +
5805 $wgGrantPermissions['viewdeleted'];
5806 $wgGrantPermissions['delete']['delete'] = true;
5807 $wgGrantPermissions['delete']['bigdelete'] = true;
5808 $wgGrantPermissions['delete']['deletelogentry'] = true;
5809 $wgGrantPermissions['delete']['deleterevision'] = true;
5810 $wgGrantPermissions['delete']['undelete'] = true;
5812 $wgGrantPermissions['protect'] = $wgGrantPermissions['editprotected'];
5813 $wgGrantPermissions['protect']['protect'] = true;
5815 $wgGrantPermissions['viewmywatchlist']['viewmywatchlist'] = true;
5817 $wgGrantPermissions['editmywatchlist']['editmywatchlist'] = true;
5819 $wgGrantPermissions['sendemail']['sendemail'] = true;
5821 $wgGrantPermissions['createaccount']['createaccount'] = true;
5823 $wgGrantPermissions['privateinfo']['viewmyprivateinfo'] = true;
5826 * @var Array Map of grants to their UI grouping
5827 * @since 1.27
5829 $wgGrantPermissionGroups = [
5830 // Hidden grants are implicitly present
5831 'basic' => 'hidden',
5833 'editpage' => 'page-interaction',
5834 'createeditmovepage' => 'page-interaction',
5835 'editprotected' => 'page-interaction',
5836 'patrol' => 'page-interaction',
5838 'uploadfile' => 'file-interaction',
5839 'uploadeditmovefile' => 'file-interaction',
5841 'sendemail' => 'email',
5843 'viewmywatchlist' => 'watchlist-interaction',
5844 'editviewmywatchlist' => 'watchlist-interaction',
5846 'editmycssjs' => 'customization',
5847 'editmyoptions' => 'customization',
5849 'editinterface' => 'administration',
5850 'rollback' => 'administration',
5851 'blockusers' => 'administration',
5852 'delete' => 'administration',
5853 'viewdeleted' => 'administration',
5854 'viewrestrictedlogs' => 'administration',
5855 'protect' => 'administration',
5856 'createaccount' => 'administration',
5858 'highvolume' => 'high-volume',
5860 'privateinfo' => 'private-information',
5864 * @var bool Whether to enable bot passwords
5865 * @since 1.27
5867 $wgEnableBotPasswords = true;
5870 * Cluster for the bot_passwords table
5871 * @var string|bool If false, the normal cluster will be used
5872 * @since 1.27
5874 $wgBotPasswordsCluster = false;
5877 * Database name for the bot_passwords table
5879 * To use a database with a table prefix, set this variable to
5880 * "{$database}-{$prefix}".
5881 * @var string|bool If false, the normal database will be used
5882 * @since 1.27
5884 $wgBotPasswordsDatabase = false;
5887 * Whether to disable user group expiry. This is a transitional feature flag
5888 * in accordance with WMF schema change policy, and will be removed later
5889 * (hopefully before MW 1.29 release).
5891 * @since 1.29
5893 $wgDisableUserGroupExpiry = false;
5895 /** @} */ # end of user rights settings
5897 /************************************************************************//**
5898 * @name Proxy scanner settings
5899 * @{
5903 * This should always be customised in LocalSettings.php
5905 $wgSecretKey = false;
5908 * Big list of banned IP addresses.
5910 * This can have the following formats:
5911 * - An array of addresses, either in the values
5912 * or the keys (for backward compatibility)
5913 * - A string, in that case this is the path to a file
5914 * containing the list of IP addresses, one per line
5916 $wgProxyList = [];
5918 /** @} */ # end of proxy scanner settings
5920 /************************************************************************//**
5921 * @name Cookie settings
5922 * @{
5926 * Default cookie lifetime, in seconds. Setting to 0 makes all cookies session-only.
5928 $wgCookieExpiration = 30 * 86400;
5931 * Default login cookie lifetime, in seconds. Setting
5932 * $wgExtendLoginCookieExpiration to null will use $wgCookieExpiration to
5933 * calculate the cookie lifetime. As with $wgCookieExpiration, 0 will make
5934 * login cookies session-only.
5936 $wgExtendedLoginCookieExpiration = 180 * 86400;
5939 * Set to set an explicit domain on the login cookies eg, "justthis.domain.org"
5940 * or ".any.subdomain.net"
5942 $wgCookieDomain = '';
5945 * Set this variable if you want to restrict cookies to a certain path within
5946 * the domain specified by $wgCookieDomain.
5948 $wgCookiePath = '/';
5951 * Whether the "secure" flag should be set on the cookie. This can be:
5952 * - true: Set secure flag
5953 * - false: Don't set secure flag
5954 * - "detect": Set the secure flag if $wgServer is set to an HTTPS URL
5956 $wgCookieSecure = 'detect';
5959 * By default, MediaWiki checks if the client supports cookies during the
5960 * login process, so that it can display an informative error message if
5961 * cookies are disabled. Set this to true if you want to disable this cookie
5962 * check.
5964 $wgDisableCookieCheck = false;
5967 * Cookies generated by MediaWiki have names starting with this prefix. Set it
5968 * to a string to use a custom prefix. Setting it to false causes the database
5969 * name to be used as a prefix.
5971 $wgCookiePrefix = false;
5974 * Set authentication cookies to HttpOnly to prevent access by JavaScript,
5975 * in browsers that support this feature. This can mitigates some classes of
5976 * XSS attack.
5978 $wgCookieHttpOnly = true;
5981 * A list of cookies that vary the cache (for use by extensions)
5983 $wgCacheVaryCookies = [];
5986 * Override to customise the session name
5988 $wgSessionName = false;
5991 * Whether to set a cookie when a user is autoblocked. Doing so means that a blocked user, even
5992 * after logging out and moving to a new IP address, will still be blocked.
5994 $wgCookieSetOnAutoblock = false;
5996 /** @} */ # end of cookie settings }
5998 /************************************************************************//**
5999 * @name LaTeX (mathematical formulas)
6000 * @{
6004 * To use inline TeX, you need to compile 'texvc' (in the 'math' subdirectory of
6005 * the MediaWiki package and have latex, dvips, gs (ghostscript), andconvert
6006 * (ImageMagick) installed and available in the PATH.
6007 * Please see math/README for more information.
6009 $wgUseTeX = false;
6011 /** @} */ # end LaTeX }
6013 /************************************************************************//**
6014 * @name Profiling, testing and debugging
6016 * To enable profiling, edit StartProfiler.php
6018 * @{
6022 * Filename for debug logging. See https://www.mediawiki.org/wiki/How_to_debug
6023 * The debug log file should be not be publicly accessible if it is used, as it
6024 * may contain private data.
6026 $wgDebugLogFile = '';
6029 * Prefix for debug log lines
6031 $wgDebugLogPrefix = '';
6034 * If true, instead of redirecting, show a page with a link to the redirect
6035 * destination. This allows for the inspection of PHP error messages, and easy
6036 * resubmission of form data. For developer use only.
6038 $wgDebugRedirects = false;
6041 * If true, log debugging data from action=raw and load.php.
6042 * This is normally false to avoid overlapping debug entries due to gen=css
6043 * and gen=js requests.
6045 $wgDebugRawPage = false;
6048 * Send debug data to an HTML comment in the output.
6050 * This may occasionally be useful when supporting a non-technical end-user.
6051 * It's more secure than exposing the debug log file to the web, since the
6052 * output only contains private data for the current user. But it's not ideal
6053 * for development use since data is lost on fatal errors and redirects.
6055 $wgDebugComments = false;
6058 * Write SQL queries to the debug log.
6060 * This setting is only used $wgLBFactoryConf['class'] is set to
6061 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
6062 * the DBO_DEBUG flag must be set in the 'flags' option of the database
6063 * connection to achieve the same functionality.
6065 $wgDebugDumpSql = false;
6068 * Performance expectations for DB usage
6070 * @since 1.26
6072 $wgTrxProfilerLimits = [
6073 // HTTP GET/HEAD requests.
6074 // Master queries should not happen on GET requests
6075 'GET' => [
6076 'masterConns' => 0,
6077 'writes' => 0,
6078 'readQueryTime' => 5
6080 // HTTP POST requests.
6081 // Master reads and writes will happen for a subset of these.
6082 'POST' => [
6083 'readQueryTime' => 5,
6084 'writeQueryTime' => 1,
6085 'maxAffected' => 1000
6087 'POST-nonwrite' => [
6088 'masterConns' => 0,
6089 'writes' => 0,
6090 'readQueryTime' => 5
6092 // Deferred updates that run after HTTP response is sent
6093 'PostSend' => [
6094 'readQueryTime' => 5,
6095 'writeQueryTime' => 1,
6096 'maxAffected' => 1000
6098 // Background job runner
6099 'JobRunner' => [
6100 'readQueryTime' => 30,
6101 'writeQueryTime' => 5,
6102 'maxAffected' => 500 // ballpark of $wgUpdateRowsPerQuery
6104 // Command-line scripts
6105 'Maintenance' => [
6106 'writeQueryTime' => 5,
6107 'maxAffected' => 1000
6112 * Map of string log group names to log destinations.
6114 * If set, wfDebugLog() output for that group will go to that file instead
6115 * of the regular $wgDebugLogFile. Useful for enabling selective logging
6116 * in production.
6118 * Log destinations may be one of the following:
6119 * - false to completely remove from the output, including from $wgDebugLogFile.
6120 * - string values specifying a filename or URI.
6121 * - associative array with keys:
6122 * - 'destination' desired filename or URI.
6123 * - 'sample' an integer value, specifying a sampling factor (optional)
6124 * - 'level' A \Psr\Log\LogLevel constant, indicating the minimum level
6125 * to log (optional, since 1.25)
6127 * @par Example:
6128 * @code
6129 * $wgDebugLogGroups['redis'] = '/var/log/mediawiki/redis.log';
6130 * @endcode
6132 * @par Advanced example:
6133 * @code
6134 * $wgDebugLogGroups['memcached'] = [
6135 * 'destination' => '/var/log/mediawiki/memcached.log',
6136 * 'sample' => 1000, // log 1 message out of every 1,000.
6137 * 'level' => \Psr\Log\LogLevel::WARNING
6138 * ];
6139 * @endcode
6141 $wgDebugLogGroups = [];
6144 * Default service provider for creating Psr\Log\LoggerInterface instances.
6146 * The value should be an array suitable for use with
6147 * ObjectFactory::getObjectFromSpec(). The created object is expected to
6148 * implement the MediaWiki\Logger\Spi interface. See ObjectFactory for additional
6149 * details.
6151 * Alternately the MediaWiki\Logger\LoggerFactory::registerProvider method can
6152 * be called to inject an MediaWiki\Logger\Spi instance into the LoggerFactory
6153 * and bypass the use of this configuration variable entirely.
6155 * @par To completely disable logging:
6156 * @code
6157 * $wgMWLoggerDefaultSpi = [ 'class' => '\\MediaWiki\\Logger\\NullSpi' ];
6158 * @endcode
6160 * @since 1.25
6161 * @var array $wgMWLoggerDefaultSpi
6162 * @see MwLogger
6164 $wgMWLoggerDefaultSpi = [
6165 'class' => '\\MediaWiki\\Logger\\LegacySpi',
6169 * Display debug data at the bottom of the main content area.
6171 * Useful for developers and technical users trying to working on a closed wiki.
6173 $wgShowDebug = false;
6176 * Prefix debug messages with relative timestamp. Very-poor man's profiler.
6177 * Since 1.19 also includes memory usage.
6179 $wgDebugTimestamps = false;
6182 * Print HTTP headers for every request in the debug information.
6184 $wgDebugPrintHttpHeaders = true;
6187 * Show the contents of $wgHooks in Special:Version
6189 $wgSpecialVersionShowHooks = false;
6192 * Whether to show "we're sorry, but there has been a database error" pages.
6193 * Displaying errors aids in debugging, but may display information useful
6194 * to an attacker.
6196 $wgShowSQLErrors = false;
6199 * If set to true, uncaught exceptions will print a complete stack trace
6200 * to output. This should only be used for debugging, as it may reveal
6201 * private information in function parameters due to PHP's backtrace
6202 * formatting.
6204 $wgShowExceptionDetails = false;
6207 * If true, show a backtrace for database errors
6209 * @note This setting only applies when connection errors and query errors are
6210 * reported in the normal manner. $wgShowExceptionDetails applies in other cases,
6211 * including those in which an uncaught exception is thrown from within the
6212 * exception handler.
6214 $wgShowDBErrorBacktrace = false;
6217 * If true, send the exception backtrace to the error log
6219 $wgLogExceptionBacktrace = true;
6222 * Expose backend server host names through the API and various HTML comments
6224 $wgShowHostnames = false;
6227 * Override server hostname detection with a hardcoded value.
6228 * Should be a string, default false.
6229 * @since 1.20
6231 $wgOverrideHostname = false;
6234 * If set to true MediaWiki will throw notices for some possible error
6235 * conditions and for deprecated functions.
6237 $wgDevelopmentWarnings = false;
6240 * Release limitation to wfDeprecated warnings, if set to a release number
6241 * development warnings will not be generated for deprecations added in releases
6242 * after the limit.
6244 $wgDeprecationReleaseLimit = false;
6247 * Only record profiling info for pages that took longer than this
6248 * @deprecated since 1.25: set $wgProfiler['threshold'] instead.
6250 $wgProfileLimit = 0.0;
6253 * Don't put non-profiling info into log file
6255 * @deprecated since 1.23, set the log file in
6256 * $wgDebugLogGroups['profileoutput'] instead.
6258 $wgProfileOnly = false;
6261 * Destination of statsd metrics.
6263 * A host or host:port of a statsd server. Port defaults to 8125.
6265 * If not set, statsd metrics will not be collected.
6267 * @see wfLogProfilingData
6268 * @since 1.25
6270 $wgStatsdServer = false;
6273 * Prefix for metric names sent to $wgStatsdServer.
6275 * @see MediaWikiServices::getStatsdDataFactory
6276 * @see BufferingStatsdDataFactory
6277 * @since 1.25
6279 $wgStatsdMetricPrefix = 'MediaWiki';
6282 * Sampling rate for statsd metrics as an associative array of patterns and rates.
6283 * Patterns are Unix shell patterns (e.g. 'MediaWiki.api.*').
6284 * Rates are sampling probabilities (e.g. 0.1 means 1 in 10 events are sampled).
6285 * @since 1.28
6287 $wgStatsdSamplingRates = [];
6290 * InfoAction retrieves a list of transclusion links (both to and from).
6291 * This number puts a limit on that query in the case of highly transcluded
6292 * templates.
6294 $wgPageInfoTransclusionLimit = 50;
6297 * Set this to an integer to only do synchronous site_stats updates
6298 * one every *this many* updates. The other requests go into pending
6299 * delta values in $wgMemc. Make sure that $wgMemc is a global cache.
6300 * If set to -1, updates *only* go to $wgMemc (useful for daemons).
6302 $wgSiteStatsAsyncFactor = false;
6305 * Parser test suite files to be run by parserTests.php when no specific
6306 * filename is passed to it.
6308 * Extensions may add their own tests to this array, or site-local tests
6309 * may be added via LocalSettings.php
6311 * Use full paths.
6313 $wgParserTestFiles = [
6314 "$IP/tests/parser/parserTests.txt",
6315 "$IP/tests/parser/extraParserTests.txt"
6319 * Allow running of javascript test suites via [[Special:JavaScriptTest]] (such as QUnit).
6321 $wgEnableJavaScriptTest = false;
6324 * Overwrite the caching key prefix with custom value.
6325 * @since 1.19
6327 $wgCachePrefix = false;
6330 * Display the new debugging toolbar. This also enables profiling on database
6331 * queries and other useful output.
6332 * Will be ignored if $wgUseFileCache or $wgUseSquid is enabled.
6334 * @since 1.19
6336 $wgDebugToolbar = false;
6338 /** @} */ # end of profiling, testing and debugging }
6340 /************************************************************************//**
6341 * @name Search
6342 * @{
6346 * Set this to true to disable the full text search feature.
6348 $wgDisableTextSearch = false;
6351 * Set to true to have nicer highlighted text in search results,
6352 * by default off due to execution overhead
6354 $wgAdvancedSearchHighlighting = false;
6357 * Regexp to match word boundaries, defaults for non-CJK languages
6358 * should be empty for CJK since the words are not separate
6360 $wgSearchHighlightBoundaries = '[\p{Z}\p{P}\p{C}]';
6363 * Template for OpenSearch suggestions, defaults to API action=opensearch
6365 * Sites with heavy load would typically have these point to a custom
6366 * PHP wrapper to avoid firing up mediawiki for every keystroke
6368 * Placeholders: {searchTerms}
6370 * @deprecated since 1.25 Use $wgOpenSearchTemplates['application/x-suggestions+json'] instead
6372 $wgOpenSearchTemplate = false;
6375 * Templates for OpenSearch suggestions, defaults to API action=opensearch
6377 * Sites with heavy load would typically have these point to a custom
6378 * PHP wrapper to avoid firing up mediawiki for every keystroke
6380 * Placeholders: {searchTerms}
6382 $wgOpenSearchTemplates = [
6383 'application/x-suggestions+json' => false,
6384 'application/x-suggestions+xml' => false,
6388 * Enable OpenSearch suggestions requested by MediaWiki. Set this to
6389 * false if you've disabled scripts that use api?action=opensearch and
6390 * want reduce load caused by cached scripts still pulling suggestions.
6391 * It will let the API fallback by responding with an empty array.
6393 $wgEnableOpenSearchSuggest = true;
6396 * Integer defining default number of entries to show on
6397 * OpenSearch call.
6399 $wgOpenSearchDefaultLimit = 10;
6402 * Minimum length of extract in <Description>. Actual extracts will last until the end of sentence.
6404 $wgOpenSearchDescriptionLength = 100;
6407 * Expiry time for search suggestion responses
6409 $wgSearchSuggestCacheExpiry = 1200;
6412 * If you've disabled search semi-permanently, this also disables updates to the
6413 * table. If you ever re-enable, be sure to rebuild the search table.
6415 $wgDisableSearchUpdate = false;
6418 * List of namespaces which are searched by default.
6420 * @par Example:
6421 * @code
6422 * $wgNamespacesToBeSearchedDefault[NS_MAIN] = true;
6423 * $wgNamespacesToBeSearchedDefault[NS_PROJECT] = true;
6424 * @endcode
6426 $wgNamespacesToBeSearchedDefault = [
6427 NS_MAIN => true,
6431 * Disable the internal MySQL-based search, to allow it to be
6432 * implemented by an extension instead.
6434 $wgDisableInternalSearch = false;
6437 * Set this to a URL to forward search requests to some external location.
6438 * If the URL includes '$1', this will be replaced with the URL-encoded
6439 * search term.
6441 * @par Example:
6442 * To forward to Google you'd have something like:
6443 * @code
6444 * $wgSearchForwardUrl =
6445 * 'https://www.google.com/search?q=$1' .
6446 * '&domains=https://example.com' .
6447 * '&sitesearch=https://example.com' .
6448 * '&ie=utf-8&oe=utf-8';
6449 * @endcode
6451 $wgSearchForwardUrl = null;
6454 * Search form behavior.
6455 * - true = use Go & Search buttons
6456 * - false = use Go button & Advanced search link
6458 $wgUseTwoButtonsSearchForm = true;
6461 * Array of namespaces to generate a Google sitemap for when the
6462 * maintenance/generateSitemap.php script is run, or false if one is to be
6463 * generated for all namespaces.
6465 $wgSitemapNamespaces = false;
6468 * Custom namespace priorities for sitemaps. Setting this will allow you to
6469 * set custom priorities to namespaces when sitemaps are generated using the
6470 * maintenance/generateSitemap.php script.
6472 * This should be a map of namespace IDs to priority
6473 * @par Example:
6474 * @code
6475 * $wgSitemapNamespacesPriorities = [
6476 * NS_USER => '0.9',
6477 * NS_HELP => '0.0',
6478 * ];
6479 * @endcode
6481 $wgSitemapNamespacesPriorities = false;
6484 * If true, searches for IP addresses will be redirected to that IP's
6485 * contributions page. E.g. searching for "1.2.3.4" will redirect to
6486 * [[Special:Contributions/1.2.3.4]]
6488 $wgEnableSearchContributorsByIP = true;
6490 /** @} */ # end of search settings
6492 /************************************************************************//**
6493 * @name Edit user interface
6494 * @{
6498 * Path to the GNU diff3 utility. If the file doesn't exist, edit conflicts will
6499 * fall back to the old behavior (no merging).
6501 $wgDiff3 = '/usr/bin/diff3';
6504 * Path to the GNU diff utility.
6506 $wgDiff = '/usr/bin/diff';
6509 * Which namespaces have special treatment where they should be preview-on-open
6510 * Internally only Category: pages apply, but using this extensions (e.g. Semantic MediaWiki)
6511 * can specify namespaces of pages they have special treatment for
6513 $wgPreviewOnOpenNamespaces = [
6514 NS_CATEGORY => true
6518 * Enable the UniversalEditButton for browsers that support it
6519 * (currently only Firefox with an extension)
6520 * See http://universaleditbutton.org for more background information
6522 $wgUniversalEditButton = true;
6525 * If user doesn't specify any edit summary when making a an edit, MediaWiki
6526 * will try to automatically create one. This feature can be disabled by set-
6527 * ting this variable false.
6529 $wgUseAutomaticEditSummaries = true;
6531 /** @} */ # end edit UI }
6533 /************************************************************************//**
6534 * @name Maintenance
6535 * See also $wgSiteNotice
6536 * @{
6540 * @cond file_level_code
6541 * Set $wgCommandLineMode if it's not set already, to avoid notices
6543 if ( !isset( $wgCommandLineMode ) ) {
6544 $wgCommandLineMode = false;
6546 /** @endcond */
6549 * For colorized maintenance script output, is your terminal background dark ?
6551 $wgCommandLineDarkBg = false;
6554 * Set this to a string to put the wiki into read-only mode. The text will be
6555 * used as an explanation to users.
6557 * This prevents most write operations via the web interface. Cache updates may
6558 * still be possible. To prevent database writes completely, use the read_only
6559 * option in MySQL.
6561 $wgReadOnly = null;
6564 * If this lock file exists (size > 0), the wiki will be forced into read-only mode.
6565 * Its contents will be shown to users as part of the read-only warning
6566 * message.
6568 * Will default to "{$wgUploadDirectory}/lock_yBgMBwiR" in Setup.php
6570 $wgReadOnlyFile = false;
6573 * When you run the web-based upgrade utility, it will tell you what to set
6574 * this to in order to authorize the upgrade process. It will subsequently be
6575 * used as a password, to authorize further upgrades.
6577 * For security, do not set this to a guessable string. Use the value supplied
6578 * by the install/upgrade process. To cause the upgrader to generate a new key,
6579 * delete the old key from LocalSettings.php.
6581 $wgUpgradeKey = false;
6584 * Fully specified path to git binary
6586 $wgGitBin = '/usr/bin/git';
6589 * Map GIT repository URLs to viewer URLs to provide links in Special:Version
6591 * Key is a pattern passed to preg_match() and preg_replace(),
6592 * without the delimiters (which are #) and must match the whole URL.
6593 * The value is the replacement for the key (it can contain $1, etc.)
6594 * %h will be replaced by the short SHA-1 (7 first chars) and %H by the
6595 * full SHA-1 of the HEAD revision.
6596 * %r will be replaced with a URL-encoded version of $1.
6597 * %R will be replaced with $1 and no URL-encoding
6599 * @since 1.20
6601 $wgGitRepositoryViewers = [
6602 'https://(?:[a-z0-9_]+@)?gerrit.wikimedia.org/r/(?:p/)?(.*)' =>
6603 'https://phabricator.wikimedia.org/r/revision/%R;%H',
6604 'ssh://(?:[a-z0-9_]+@)?gerrit.wikimedia.org:29418/(.*)' =>
6605 'https://phabricator.wikimedia.org/r/revision/%R;%H',
6608 /** @} */ # End of maintenance }
6610 /************************************************************************//**
6611 * @name Recent changes, new pages, watchlist and history
6612 * @{
6616 * Recentchanges items are periodically purged; entries older than this many
6617 * seconds will go.
6618 * Default: 90 days = about three months
6620 $wgRCMaxAge = 90 * 24 * 3600;
6623 * Page watchers inactive for more than this many seconds are considered inactive.
6624 * Used mainly by action=info. Default: 180 days = about six months.
6625 * @since 1.26
6627 $wgWatchersMaxAge = 180 * 24 * 3600;
6630 * If active watchers (per above) are this number or less, do not disclose it.
6631 * Left to 1, prevents unprivileged users from knowing for sure that there are 0.
6632 * Set to -1 if you want to always complement watchers count with this info.
6633 * @since 1.26
6635 $wgUnwatchedPageSecret = 1;
6638 * Filter $wgRCLinkDays by $wgRCMaxAge to avoid showing links for numbers
6639 * higher than what will be stored. Note that this is disabled by default
6640 * because we sometimes do have RC data which is beyond the limit for some
6641 * reason, and some users may use the high numbers to display that data which
6642 * is still there.
6644 $wgRCFilterByAge = false;
6647 * List of Limits options to list in the Special:Recentchanges and
6648 * Special:Recentchangeslinked pages.
6650 $wgRCLinkLimits = [ 50, 100, 250, 500 ];
6653 * List of Days options to list in the Special:Recentchanges and
6654 * Special:Recentchangeslinked pages.
6656 $wgRCLinkDays = [ 1, 3, 7, 14, 30 ];
6659 * Configuration for feeds to which notifications about recent changes will be sent.
6661 * The following feed classes are available by default:
6662 * - 'UDPRCFeedEngine' - sends recent changes over UDP to the specified server.
6663 * - 'RedisPubSubFeedEngine' - send recent changes to Redis.
6665 * Only 'class' or 'uri' is required. If 'uri' is set instead of 'class', then
6666 * RecentChange::getEngine() is used to determine the class. All options are
6667 * passed to the constructor.
6669 * Common options:
6670 * - 'class' -- The class to use for this feed (must implement RCFeed).
6671 * - 'omit_bots' -- Exclude bot edits from the feed. (default: false)
6672 * - 'omit_anon' -- Exclude anonymous edits from the feed. (default: false)
6673 * - 'omit_user' -- Exclude edits by registered users from the feed. (default: false)
6674 * - 'omit_minor' -- Exclude minor edits from the feed. (default: false)
6675 * - 'omit_patrolled' -- Exclude patrolled edits from the feed. (default: false)
6677 * FormattedRCFeed-specific options:
6678 * - 'uri' -- [required] The address to which the messages are sent.
6679 * The uri scheme of this string will be looked up in $wgRCEngines
6680 * to determine which RCFeedEngine class to use.
6681 * - 'formatter' -- [required] The class (implementing RCFeedFormatter) which will
6682 * produce the text to send. This can also be an object of the class.
6683 * Formatters available by default: JSONRCFeedFormatter, XMLRCFeedFormatter,
6684 * IRCColourfulRCFeedFormatter.
6686 * IRCColourfulRCFeedFormatter-specific options:
6687 * - 'add_interwiki_prefix' -- whether the titles should be prefixed with
6688 * the first entry in the $wgLocalInterwikis array (or the value of
6689 * $wgLocalInterwiki, if set)
6691 * JSONRCFeedFormatter-specific options:
6692 * - 'channel' -- if set, the 'channel' parameter is also set in JSON values.
6694 * @example $wgRCFeeds['example'] = [
6695 * 'uri' => 'udp://localhost:1336',
6696 * 'formatter' => 'JSONRCFeedFormatter',
6697 * 'add_interwiki_prefix' => false,
6698 * 'omit_bots' => true,
6699 * ];
6700 * @example $wgRCFeeds['example'] = [
6701 * 'uri' => 'udp://localhost:1338',
6702 * 'formatter' => 'IRCColourfulRCFeedFormatter',
6703 * 'add_interwiki_prefix' => false,
6704 * 'omit_bots' => true,
6705 * ];
6706 * @example $wgRCFeeds['example'] = [
6707 * 'class' => 'ExampleRCFeed',
6708 * ];
6709 * @since 1.22
6711 $wgRCFeeds = [];
6714 * Used by RecentChange::getEngine to find the correct engine for a given URI scheme.
6715 * Keys are scheme names, values are names of FormattedRCFeed sub classes.
6716 * @since 1.22
6718 $wgRCEngines = [
6719 'redis' => 'RedisPubSubFeedEngine',
6720 'udp' => 'UDPRCFeedEngine',
6724 * Treat category membership changes as a RecentChange.
6725 * Changes are mentioned in RC for page actions as follows:
6726 * - creation: pages created with categories are mentioned
6727 * - edit: category additions/removals to existing pages are mentioned
6728 * - move: nothing is mentioned (unless templates used depend on the title)
6729 * - deletion: nothing is mentioned
6730 * - undeletion: nothing is mentioned
6732 * @since 1.27
6734 $wgRCWatchCategoryMembership = false;
6737 * Use RC Patrolling to check for vandalism (from recent changes and watchlists)
6738 * New pages and new files are included.
6740 $wgUseRCPatrol = true;
6743 * Use new page patrolling to check new pages on Special:Newpages
6745 $wgUseNPPatrol = true;
6748 * Use file patrolling to check new files on Special:Newfiles
6750 * @since 1.27
6752 $wgUseFilePatrol = true;
6755 * Log autopatrol actions to the log table
6757 $wgLogAutopatrol = true;
6760 * Provide syndication feeds (RSS, Atom) for, e.g., Recentchanges, Newpages
6762 $wgFeed = true;
6765 * Set maximum number of results to return in syndication feeds (RSS, Atom) for
6766 * eg Recentchanges, Newpages.
6768 $wgFeedLimit = 50;
6771 * _Minimum_ timeout for cached Recentchanges feed, in seconds.
6772 * A cached version will continue to be served out even if changes
6773 * are made, until this many seconds runs out since the last render.
6775 * If set to 0, feed caching is disabled. Use this for debugging only;
6776 * feed generation can be pretty slow with diffs.
6778 $wgFeedCacheTimeout = 60;
6781 * When generating Recentchanges RSS/Atom feed, diffs will not be generated for
6782 * pages larger than this size.
6784 $wgFeedDiffCutoff = 32768;
6787 * Override the site's default RSS/ATOM feed for recentchanges that appears on
6788 * every page. Some sites might have a different feed they'd like to promote
6789 * instead of the RC feed (maybe like a "Recent New Articles" or "Breaking news" one).
6790 * Should be a format as key (either 'rss' or 'atom') and an URL to the feed
6791 * as value.
6792 * @par Example:
6793 * Configure the 'atom' feed to https://example.com/somefeed.xml
6794 * @code
6795 * $wgSiteFeed['atom'] = "https://example.com/somefeed.xml";
6796 * @endcode
6798 $wgOverrideSiteFeed = [];
6801 * Available feeds objects.
6802 * Should probably only be defined when a page is syndicated ie when
6803 * $wgOut->isSyndicated() is true.
6805 $wgFeedClasses = [
6806 'rss' => 'RSSFeed',
6807 'atom' => 'AtomFeed',
6811 * Which feed types should we provide by default? This can include 'rss',
6812 * 'atom', neither, or both.
6814 $wgAdvertisedFeedTypes = [ 'atom' ];
6817 * Show watching users in recent changes, watchlist and page history views
6819 $wgRCShowWatchingUsers = false; # UPO
6822 * Show the amount of changed characters in recent changes
6824 $wgRCShowChangedSize = true;
6827 * If the difference between the character counts of the text
6828 * before and after the edit is below that value, the value will be
6829 * highlighted on the RC page.
6831 $wgRCChangedSizeThreshold = 500;
6834 * Show "Updated (since my last visit)" marker in RC view, watchlist and history
6835 * view for watched pages with new changes
6837 $wgShowUpdatedMarker = true;
6840 * Disable links to talk pages of anonymous users (IPs) in listings on special
6841 * pages like page history, Special:Recentchanges, etc.
6843 $wgDisableAnonTalk = false;
6846 * Enable filtering of categories in Recentchanges
6848 $wgAllowCategorizedRecentChanges = false;
6851 * Allow filtering by change tag in recentchanges, history, etc
6852 * Has no effect if no tags are defined in valid_tag.
6854 $wgUseTagFilter = true;
6857 * If set to an integer, pages that are watched by this many users or more
6858 * will not require the unwatchedpages permission to view the number of
6859 * watchers.
6861 * @since 1.21
6863 $wgUnwatchedPageThreshold = false;
6866 * Flags (letter symbols) shown in recent changes and watchlist to indicate
6867 * certain types of edits.
6869 * To register a new one:
6870 * @code
6871 * $wgRecentChangesFlags['flag'] => [
6872 * // message for the letter displayed next to rows on changes lists
6873 * 'letter' => 'letter-msg',
6874 * // message for the tooltip of the letter
6875 * 'title' => 'tooltip-msg',
6876 * // optional (defaults to 'tooltip-msg'), message to use in the legend box
6877 * 'legend' => 'legend-msg',
6878 * // optional (defaults to 'flag'), CSS class to put on changes lists rows
6879 * 'class' => 'css-class',
6880 * // optional (defaults to 'any'), how top-level flag is determined. 'any'
6881 * // will set the top-level flag if any line contains the flag, 'all' will
6882 * // only be set if all lines contain the flag.
6883 * 'grouping' => 'any',
6884 * ];
6885 * @endcode
6887 * @since 1.22
6889 $wgRecentChangesFlags = [
6890 'newpage' => [
6891 'letter' => 'newpageletter',
6892 'title' => 'recentchanges-label-newpage',
6893 'legend' => 'recentchanges-legend-newpage',
6894 'grouping' => 'any',
6896 'minor' => [
6897 'letter' => 'minoreditletter',
6898 'title' => 'recentchanges-label-minor',
6899 'legend' => 'recentchanges-legend-minor',
6900 'class' => 'minoredit',
6901 'grouping' => 'all',
6903 'bot' => [
6904 'letter' => 'boteditletter',
6905 'title' => 'recentchanges-label-bot',
6906 'legend' => 'recentchanges-legend-bot',
6907 'class' => 'botedit',
6908 'grouping' => 'all',
6910 'unpatrolled' => [
6911 'letter' => 'unpatrolledletter',
6912 'title' => 'recentchanges-label-unpatrolled',
6913 'legend' => 'recentchanges-legend-unpatrolled',
6914 'grouping' => 'any',
6918 /** @} */ # end RC/watchlist }
6920 /************************************************************************//**
6921 * @name Copyright and credits settings
6922 * @{
6926 * Override for copyright metadata.
6928 * This is the name of the page containing information about the wiki's copyright status,
6929 * which will be added as a link in the footer if it is specified. It overrides
6930 * $wgRightsUrl if both are specified.
6932 $wgRightsPage = null;
6935 * Set this to specify an external URL containing details about the content license used on your
6936 * wiki.
6937 * If $wgRightsPage is set then this setting is ignored.
6939 $wgRightsUrl = null;
6942 * If either $wgRightsUrl or $wgRightsPage is specified then this variable gives the text for the
6943 * link.
6944 * If using $wgRightsUrl then this value must be specified. If using $wgRightsPage then the name
6945 * of the page will also be used as the link if this variable is not set.
6947 $wgRightsText = null;
6950 * Override for copyright metadata.
6952 $wgRightsIcon = null;
6955 * Set this to true if you want detailed copyright information forms on Upload.
6957 $wgUseCopyrightUpload = false;
6960 * Set this to the number of authors that you want to be credited below an
6961 * article text. Set it to zero to hide the attribution block, and a negative
6962 * number (like -1) to show all authors. Note that this will require 2-3 extra
6963 * database hits, which can have a not insignificant impact on performance for
6964 * large wikis.
6966 $wgMaxCredits = 0;
6969 * If there are more than $wgMaxCredits authors, show $wgMaxCredits of them.
6970 * Otherwise, link to a separate credits page.
6972 $wgShowCreditsIfMax = true;
6974 /** @} */ # end of copyright and credits settings }
6976 /************************************************************************//**
6977 * @name Import / Export
6978 * @{
6982 * List of interwiki prefixes for wikis we'll accept as sources for
6983 * Special:Import and API action=import. Since complete page history can be
6984 * imported, these should be 'trusted'.
6986 * This can either be a regular array, or an associative map specifying
6987 * subprojects on the interwiki map of the target wiki, or a mix of the two,
6988 * e.g.
6989 * @code
6990 * $wgImportSources = [
6991 * 'wikipedia' => [ 'cs', 'en', 'fr', 'zh' ],
6992 * 'wikispecies',
6993 * 'wikia' => [ 'animanga', 'brickipedia', 'desserts' ],
6994 * ];
6995 * @endcode
6997 * If you have a very complex import sources setup, you can lazy-load it using
6998 * the ImportSources hook.
7000 * If a user has the 'import' permission but not the 'importupload' permission,
7001 * they will only be able to run imports through this transwiki interface.
7003 $wgImportSources = [];
7006 * Optional default target namespace for interwiki imports.
7007 * Can use this to create an incoming "transwiki"-style queue.
7008 * Set to numeric key, not the name.
7010 * Users may override this in the Special:Import dialog.
7012 $wgImportTargetNamespace = null;
7015 * If set to false, disables the full-history option on Special:Export.
7016 * This is currently poorly optimized for long edit histories, so is
7017 * disabled on Wikimedia's sites.
7019 $wgExportAllowHistory = true;
7022 * If set nonzero, Special:Export requests for history of pages with
7023 * more revisions than this will be rejected. On some big sites things
7024 * could get bogged down by very very long pages.
7026 $wgExportMaxHistory = 0;
7029 * Return distinct author list (when not returning full history)
7031 $wgExportAllowListContributors = false;
7034 * If non-zero, Special:Export accepts a "pagelink-depth" parameter
7035 * up to this specified level, which will cause it to include all
7036 * pages linked to from the pages you specify. Since this number
7037 * can become *insanely large* and could easily break your wiki,
7038 * it's disabled by default for now.
7040 * @warning There's a HARD CODED limit of 5 levels of recursion to prevent a
7041 * crazy-big export from being done by someone setting the depth number too
7042 * high. In other words, last resort safety net.
7044 $wgExportMaxLinkDepth = 0;
7047 * Whether to allow the "export all pages in namespace" option
7049 $wgExportFromNamespaces = false;
7052 * Whether to allow exporting the entire wiki into a single file
7054 $wgExportAllowAll = false;
7057 * Maximum number of pages returned by the GetPagesFromCategory and
7058 * GetPagesFromNamespace functions.
7060 * @since 1.27
7062 $wgExportPagelistLimit = 5000;
7064 /** @} */ # end of import/export }
7066 /*************************************************************************//**
7067 * @name Extensions
7068 * @{
7072 * A list of callback functions which are called once MediaWiki is fully
7073 * initialised
7075 $wgExtensionFunctions = [];
7078 * Extension messages files.
7080 * Associative array mapping extension name to the filename where messages can be
7081 * found. The file should contain variable assignments. Any of the variables
7082 * present in languages/messages/MessagesEn.php may be defined, but $messages
7083 * is the most common.
7085 * Variables defined in extensions will override conflicting variables defined
7086 * in the core.
7088 * Since MediaWiki 1.23, use of this variable to define messages is discouraged; instead, store
7089 * messages in JSON format and use $wgMessagesDirs. For setting other variables than
7090 * $messages, $wgExtensionMessagesFiles should still be used. Use a DIFFERENT key because
7091 * any entry having a key that also exists in $wgMessagesDirs will be ignored.
7093 * Extensions using the JSON message format can preserve backward compatibility with
7094 * earlier versions of MediaWiki by using a compatibility shim, such as one generated
7095 * by the generateJsonI18n.php maintenance script, listing it under the SAME key
7096 * as for the $wgMessagesDirs entry.
7098 * @par Example:
7099 * @code
7100 * $wgExtensionMessagesFiles['ConfirmEdit'] = __DIR__.'/ConfirmEdit.i18n.php';
7101 * @endcode
7103 $wgExtensionMessagesFiles = [];
7106 * Extension messages directories.
7108 * Associative array mapping extension name to the path of the directory where message files can
7109 * be found. The message files are expected to be JSON files named for their language code, e.g.
7110 * en.json, de.json, etc. Extensions with messages in multiple places may specify an array of
7111 * message directories.
7113 * Message directories in core should be added to LocalisationCache::getMessagesDirs()
7115 * @par Simple example:
7116 * @code
7117 * $wgMessagesDirs['Example'] = __DIR__ . '/i18n';
7118 * @endcode
7120 * @par Complex example:
7121 * @code
7122 * $wgMessagesDirs['Example'] = [
7123 * __DIR__ . '/lib/ve/i18n',
7124 * __DIR__ . '/lib/oojs-ui/i18n',
7125 * __DIR__ . '/i18n',
7127 * @endcode
7128 * @since 1.23
7130 $wgMessagesDirs = [];
7133 * Array of files with list(s) of extension entry points to be used in
7134 * maintenance/mergeMessageFileList.php
7135 * @since 1.22
7137 $wgExtensionEntryPointListFiles = [];
7140 * Parser output hooks.
7141 * This is an associative array where the key is an extension-defined tag
7142 * (typically the extension name), and the value is a PHP callback.
7143 * These will be called as an OutputPageParserOutput hook, if the relevant
7144 * tag has been registered with the parser output object.
7146 * Registration is done with $pout->addOutputHook( $tag, $data ).
7148 * The callback has the form:
7149 * @code
7150 * function outputHook( $outputPage, $parserOutput, $data ) { ... }
7151 * @endcode
7153 $wgParserOutputHooks = [];
7156 * Whether to include the NewPP limit report as a HTML comment
7158 $wgEnableParserLimitReporting = true;
7161 * List of valid skin names
7163 * The key should be the name in all lower case, the value should be a properly
7164 * cased name for the skin. This value will be prefixed with "Skin" to create
7165 * the class name of the skin to load. Use Skin::getSkinNames() as an accessor
7166 * if you wish to have access to the full list.
7168 $wgValidSkinNames = [];
7171 * Special page list. This is an associative array mapping the (canonical) names of
7172 * special pages to either a class name to be instantiated, or a callback to use for
7173 * creating the special page object. In both cases, the result must be an instance of
7174 * SpecialPage.
7176 $wgSpecialPages = [];
7179 * Array mapping class names to filenames, for autoloading.
7181 $wgAutoloadClasses = [];
7184 * Switch controlling legacy case-insensitive classloading.
7185 * Do not disable if your wiki must support data created by PHP4, or by
7186 * MediaWiki 1.4 or earlier.
7188 $wgAutoloadAttemptLowercase = true;
7191 * An array of information about installed extensions keyed by their type.
7193 * All but 'name', 'path' and 'author' can be omitted.
7195 * @code
7196 * $wgExtensionCredits[$type][] = [
7197 * 'path' => __FILE__,
7198 * 'name' => 'Example extension',
7199 * 'namemsg' => 'exampleextension-name',
7200 * 'author' => [
7201 * 'Foo Barstein',
7202 * ],
7203 * 'version' => '1.9.0',
7204 * 'url' => 'https://example.org/example-extension/',
7205 * 'descriptionmsg' => 'exampleextension-desc',
7206 * 'license-name' => 'GPL-2.0+',
7207 * ];
7208 * @endcode
7210 * The extensions are listed on Special:Version. This page also looks for a file
7211 * named COPYING or LICENSE (optional .txt extension) and provides a link to
7212 * view said file. When the 'license-name' key is specified, this file is
7213 * interpreted as wikitext.
7215 * - $type: One of 'specialpage', 'parserhook', 'variable', 'media', 'antispam',
7216 * 'skin', 'api', or 'other', or any additional types as specified through the
7217 * ExtensionTypes hook as used in SpecialVersion::getExtensionTypes().
7219 * - name: Name of extension as an inline string instead of localizable message.
7220 * Do not omit this even if 'namemsg' is provided, as it is used to override
7221 * the path Special:Version uses to find extension's license info, and is
7222 * required for backwards-compatibility with MediaWiki 1.23 and older.
7224 * - namemsg (since MW 1.24): A message key for a message containing the
7225 * extension's name, if the name is localizable. (For example, skin names
7226 * usually are.)
7228 * - author: A string or an array of strings. Authors can be linked using
7229 * the regular wikitext link syntax. To have an internationalized version of
7230 * "and others" show, add an element "...". This element can also be linked,
7231 * for instance "[https://example ...]".
7233 * - descriptionmsg: A message key or an an array with message key and parameters:
7234 * `'descriptionmsg' => 'exampleextension-desc',`
7236 * - description: Description of extension as an inline string instead of
7237 * localizable message (omit in favour of 'descriptionmsg').
7239 * - license-name: Short name of the license (used as label for the link), such
7240 * as "GPL-2.0+" or "MIT" (https://spdx.org/licenses/ for a list of identifiers).
7242 $wgExtensionCredits = [];
7245 * Authentication plugin.
7246 * @var $wgAuth AuthPlugin
7247 * @deprecated since 1.27 use $wgAuthManagerConfig instead
7249 $wgAuth = null;
7252 * Global list of hooks.
7254 * The key is one of the events made available by MediaWiki, you can find
7255 * a description for most of them in docs/hooks.txt. The array is used
7256 * internally by Hook:run().
7258 * The value can be one of:
7260 * - A function name:
7261 * @code
7262 * $wgHooks['event_name'][] = $function;
7263 * @endcode
7264 * - A function with some data:
7265 * @code
7266 * $wgHooks['event_name'][] = [ $function, $data ];
7267 * @endcode
7268 * - A an object method:
7269 * @code
7270 * $wgHooks['event_name'][] = [ $object, 'method' ];
7271 * @endcode
7272 * - A closure:
7273 * @code
7274 * $wgHooks['event_name'][] = function ( $hookParam ) {
7275 * // Handler code goes here.
7276 * };
7277 * @endcode
7279 * @warning You should always append to an event array or you will end up
7280 * deleting a previous registered hook.
7282 * @warning Hook handlers should be registered at file scope. Registering
7283 * handlers after file scope can lead to unexpected results due to caching.
7285 $wgHooks = [];
7288 * List of service wiring files to be loaded by the default instance of MediaWikiServices.
7289 * Each file listed here is expected to return an associative array mapping service names
7290 * to instantiator functions. Extensions may add wiring files to define their own services.
7291 * However, this cannot be used to replace existing services - use the MediaWikiServices
7292 * hook for that.
7294 * @see MediaWikiServices
7295 * @see ServiceContainer::loadWiringFiles() for details on loading service instantiator functions.
7296 * @see docs/injection.txt for an overview of dependency injection in MediaWiki.
7298 $wgServiceWiringFiles = [
7299 __DIR__ . '/ServiceWiring.php'
7303 * Maps jobs to their handling classes; extensions
7304 * can add to this to provide custom jobs
7306 $wgJobClasses = [
7307 'refreshLinks' => 'RefreshLinksJob',
7308 'deleteLinks' => 'DeleteLinksJob',
7309 'htmlCacheUpdate' => 'HTMLCacheUpdateJob',
7310 'sendMail' => 'EmaillingJob',
7311 'enotifNotify' => 'EnotifNotifyJob',
7312 'fixDoubleRedirect' => 'DoubleRedirectJob',
7313 'AssembleUploadChunks' => 'AssembleUploadChunksJob',
7314 'PublishStashedFile' => 'PublishStashedFileJob',
7315 'ThumbnailRender' => 'ThumbnailRenderJob',
7316 'recentChangesUpdate' => 'RecentChangesUpdateJob',
7317 'refreshLinksPrioritized' => 'RefreshLinksJob',
7318 'refreshLinksDynamic' => 'RefreshLinksJob',
7319 'activityUpdateJob' => 'ActivityUpdateJob',
7320 'categoryMembershipChange' => 'CategoryMembershipChangeJob',
7321 'cdnPurge' => 'CdnPurgeJob',
7322 'enqueue' => 'EnqueueJob', // local queue for multi-DC setups
7323 'null' => 'NullJob'
7327 * Jobs that must be explicitly requested, i.e. aren't run by job runners unless
7328 * special flags are set. The values here are keys of $wgJobClasses.
7330 * These can be:
7331 * - Very long-running jobs.
7332 * - Jobs that you would never want to run as part of a page rendering request.
7333 * - Jobs that you want to run on specialized machines ( like transcoding, or a particular
7334 * machine on your cluster has 'outside' web access you could restrict uploadFromUrl )
7335 * These settings should be global to all wikis.
7337 $wgJobTypesExcludedFromDefaultQueue = [ 'AssembleUploadChunks', 'PublishStashedFile' ];
7340 * Map of job types to how many job "work items" should be run per second
7341 * on each job runner process. The meaning of "work items" varies per job,
7342 * but typically would be something like "pages to update". A single job
7343 * may have a variable number of work items, as is the case with batch jobs.
7344 * This is used by runJobs.php and not jobs run via $wgJobRunRate.
7345 * These settings should be global to all wikis.
7346 * @var float[]
7348 $wgJobBackoffThrottling = [];
7351 * Make job runners commit changes for replica DB-lag prone jobs one job at a time.
7352 * This is useful if there are many job workers that race on replica DB lag checks.
7353 * If set, jobs taking this many seconds of DB write time have serialized commits.
7355 * Note that affected jobs may have worse lock contention. Also, if they affect
7356 * several DBs at once they may have a smaller chance of being atomic due to the
7357 * possibility of connection loss while queueing up to commit. Affected jobs may
7358 * also fail due to the commit lock acquisition timeout.
7360 * @var float|bool
7361 * @since 1.26
7363 $wgJobSerialCommitThreshold = false;
7366 * Map of job types to configuration arrays.
7367 * This determines which queue class and storage system is used for each job type.
7368 * Job types that do not have explicit configuration will use the 'default' config.
7369 * These settings should be global to all wikis.
7371 $wgJobTypeConf = [
7372 'default' => [ 'class' => 'JobQueueDB', 'order' => 'random', 'claimTTL' => 3600 ],
7376 * Which aggregator to use for tracking which queues have jobs.
7377 * These settings should be global to all wikis.
7379 $wgJobQueueAggregator = [
7380 'class' => 'JobQueueAggregatorNull'
7384 * Additional functions to be performed with updateSpecialPages.
7385 * Expensive Querypages are already updated.
7387 $wgSpecialPageCacheUpdates = [
7388 'Statistics' => [ 'SiteStatsUpdate', 'cacheUpdate' ]
7392 * Hooks that are used for outputting exceptions. Format is:
7393 * $wgExceptionHooks[] = $funcname
7394 * or:
7395 * $wgExceptionHooks[] = [ $class, $funcname ]
7396 * Hooks should return strings or false
7398 $wgExceptionHooks = [];
7401 * Page property link table invalidation lists. When a page property
7402 * changes, this may require other link tables to be updated (eg
7403 * adding __HIDDENCAT__ means the hiddencat tracking category will
7404 * have been added, so the categorylinks table needs to be rebuilt).
7405 * This array can be added to by extensions.
7407 $wgPagePropLinkInvalidations = [
7408 'hiddencat' => 'categorylinks',
7411 /** @} */ # End extensions }
7413 /*************************************************************************//**
7414 * @name Categories
7415 * @{
7419 * Use experimental, DMOZ-like category browser
7421 $wgUseCategoryBrowser = false;
7424 * On category pages, show thumbnail gallery for images belonging to that
7425 * category instead of listing them as articles.
7427 $wgCategoryMagicGallery = true;
7430 * Paging limit for categories
7432 $wgCategoryPagingLimit = 200;
7435 * Specify how category names should be sorted, when listed on a category page.
7436 * A sorting scheme is also known as a collation.
7438 * Available values are:
7440 * - uppercase: Converts the category name to upper case, and sorts by that.
7442 * - identity: Does no conversion. Sorts by binary value of the string.
7444 * - uca-default: Provides access to the Unicode Collation Algorithm with
7445 * the default element table. This is a compromise collation which sorts
7446 * all languages in a mediocre way. However, it is better than "uppercase".
7448 * To use the uca-default collation, you must have PHP's intl extension
7449 * installed. See https://secure.php.net/manual/en/intl.setup.php . The details of the
7450 * resulting collation will depend on the version of ICU installed on the
7451 * server.
7453 * After you change this, you must run maintenance/updateCollation.php to fix
7454 * the sort keys in the database.
7456 * Extensions can define there own collations by subclassing Collation
7457 * and using the Collation::factory hook.
7459 $wgCategoryCollation = 'uppercase';
7461 /** @} */ # End categories }
7463 /*************************************************************************//**
7464 * @name Logging
7465 * @{
7469 * The logging system has two levels: an event type, which describes the
7470 * general category and can be viewed as a named subset of all logs; and
7471 * an action, which is a specific kind of event that can exist in that
7472 * log type.
7474 $wgLogTypes = [
7476 'block',
7477 'protect',
7478 'rights',
7479 'delete',
7480 'upload',
7481 'move',
7482 'import',
7483 'patrol',
7484 'merge',
7485 'suppress',
7486 'tag',
7487 'managetags',
7488 'contentmodel',
7492 * This restricts log access to those who have a certain right
7493 * Users without this will not see it in the option menu and can not view it
7494 * Restricted logs are not added to recent changes
7495 * Logs should remain non-transcludable
7496 * Format: logtype => permissiontype
7498 $wgLogRestrictions = [
7499 'suppress' => 'suppressionlog'
7503 * Show/hide links on Special:Log will be shown for these log types.
7505 * This is associative array of log type => boolean "hide by default"
7507 * See $wgLogTypes for a list of available log types.
7509 * @par Example:
7510 * @code
7511 * $wgFilterLogTypes = [ 'move' => true, 'import' => false ];
7512 * @endcode
7514 * Will display show/hide links for the move and import logs. Move logs will be
7515 * hidden by default unless the link is clicked. Import logs will be shown by
7516 * default, and hidden when the link is clicked.
7518 * A message of the form log-show-hide-[type] should be added, and will be used
7519 * for the link text.
7521 $wgFilterLogTypes = [
7522 'patrol' => true,
7523 'tag' => true,
7527 * Lists the message key string for each log type. The localized messages
7528 * will be listed in the user interface.
7530 * Extensions with custom log types may add to this array.
7532 * @since 1.19, if you follow the naming convention log-name-TYPE,
7533 * where TYPE is your log type, yoy don't need to use this array.
7535 $wgLogNames = [
7536 '' => 'all-logs-page',
7537 'block' => 'blocklogpage',
7538 'protect' => 'protectlogpage',
7539 'rights' => 'rightslog',
7540 'delete' => 'dellogpage',
7541 'upload' => 'uploadlogpage',
7542 'move' => 'movelogpage',
7543 'import' => 'importlogpage',
7544 'patrol' => 'patrol-log-page',
7545 'merge' => 'mergelog',
7546 'suppress' => 'suppressionlog',
7550 * Lists the message key string for descriptive text to be shown at the
7551 * top of each log type.
7553 * Extensions with custom log types may add to this array.
7555 * @since 1.19, if you follow the naming convention log-description-TYPE,
7556 * where TYPE is your log type, yoy don't need to use this array.
7558 $wgLogHeaders = [
7559 '' => 'alllogstext',
7560 'block' => 'blocklogtext',
7561 'delete' => 'dellogpagetext',
7562 'import' => 'importlogpagetext',
7563 'merge' => 'mergelogpagetext',
7564 'move' => 'movelogpagetext',
7565 'patrol' => 'patrol-log-header',
7566 'protect' => 'protectlogtext',
7567 'rights' => 'rightslogtext',
7568 'suppress' => 'suppressionlogtext',
7569 'upload' => 'uploadlogpagetext',
7573 * Lists the message key string for formatting individual events of each
7574 * type and action when listed in the logs.
7576 * Extensions with custom log types may add to this array.
7578 $wgLogActions = [];
7581 * The same as above, but here values are names of classes,
7582 * not messages.
7583 * @see LogPage::actionText
7584 * @see LogFormatter
7586 $wgLogActionsHandlers = [
7587 'block/block' => 'BlockLogFormatter',
7588 'block/reblock' => 'BlockLogFormatter',
7589 'block/unblock' => 'BlockLogFormatter',
7590 'contentmodel/change' => 'ContentModelLogFormatter',
7591 'contentmodel/new' => 'ContentModelLogFormatter',
7592 'delete/delete' => 'DeleteLogFormatter',
7593 'delete/delete_redir' => 'DeleteLogFormatter',
7594 'delete/event' => 'DeleteLogFormatter',
7595 'delete/restore' => 'DeleteLogFormatter',
7596 'delete/revision' => 'DeleteLogFormatter',
7597 'import/interwiki' => 'ImportLogFormatter',
7598 'import/upload' => 'ImportLogFormatter',
7599 'managetags/activate' => 'LogFormatter',
7600 'managetags/create' => 'LogFormatter',
7601 'managetags/deactivate' => 'LogFormatter',
7602 'managetags/delete' => 'LogFormatter',
7603 'merge/merge' => 'MergeLogFormatter',
7604 'move/move' => 'MoveLogFormatter',
7605 'move/move_redir' => 'MoveLogFormatter',
7606 'patrol/patrol' => 'PatrolLogFormatter',
7607 'patrol/autopatrol' => 'PatrolLogFormatter',
7608 'protect/modify' => 'ProtectLogFormatter',
7609 'protect/move_prot' => 'ProtectLogFormatter',
7610 'protect/protect' => 'ProtectLogFormatter',
7611 'protect/unprotect' => 'ProtectLogFormatter',
7612 'rights/autopromote' => 'RightsLogFormatter',
7613 'rights/rights' => 'RightsLogFormatter',
7614 'suppress/block' => 'BlockLogFormatter',
7615 'suppress/delete' => 'DeleteLogFormatter',
7616 'suppress/event' => 'DeleteLogFormatter',
7617 'suppress/reblock' => 'BlockLogFormatter',
7618 'suppress/revision' => 'DeleteLogFormatter',
7619 'tag/update' => 'TagLogFormatter',
7620 'upload/overwrite' => 'UploadLogFormatter',
7621 'upload/revert' => 'UploadLogFormatter',
7622 'upload/upload' => 'UploadLogFormatter',
7626 * List of log types that can be filtered by action types
7628 * To each action is associated the list of log_action
7629 * subtypes to search for, usually one, but not necessarily so
7630 * Extensions may append to this array
7631 * @since 1.27
7633 $wgActionFilteredLogs = [
7634 'block' => [
7635 'block' => [ 'block' ],
7636 'reblock' => [ 'reblock' ],
7637 'unblock' => [ 'unblock' ],
7639 'contentmodel' => [
7640 'change' => [ 'change' ],
7641 'new' => [ 'new' ],
7643 'delete' => [
7644 'delete' => [ 'delete' ],
7645 'delete_redir' => [ 'delete_redir' ],
7646 'restore' => [ 'restore' ],
7647 'event' => [ 'event' ],
7648 'revision' => [ 'revision' ],
7650 'import' => [
7651 'interwiki' => [ 'interwiki' ],
7652 'upload' => [ 'upload' ],
7654 'managetags' => [
7655 'create' => [ 'create' ],
7656 'delete' => [ 'delete' ],
7657 'activate' => [ 'activate' ],
7658 'deactivate' => [ 'deactivate' ],
7660 'move' => [
7661 'move' => [ 'move' ],
7662 'move_redir' => [ 'move_redir' ],
7664 'newusers' => [
7665 'create' => [ 'create', 'newusers' ],
7666 'create2' => [ 'create2' ],
7667 'autocreate' => [ 'autocreate' ],
7668 'byemail' => [ 'byemail' ],
7670 'patrol' => [
7671 'patrol' => [ 'patrol' ],
7672 'autopatrol' => [ 'autopatrol' ],
7674 'protect' => [
7675 'protect' => [ 'protect' ],
7676 'modify' => [ 'modify' ],
7677 'unprotect' => [ 'unprotect' ],
7678 'move_prot' => [ 'move_prot' ],
7680 'rights' => [
7681 'rights' => [ 'rights' ],
7682 'autopromote' => [ 'autopromote' ],
7684 'suppress' => [
7685 'event' => [ 'event' ],
7686 'revision' => [ 'revision' ],
7687 'delete' => [ 'delete' ],
7688 'block' => [ 'block' ],
7689 'reblock' => [ 'reblock' ],
7691 'upload' => [
7692 'upload' => [ 'upload' ],
7693 'overwrite' => [ 'overwrite' ],
7698 * Maintain a log of newusers at Log/newusers?
7700 $wgNewUserLog = true;
7702 /** @} */ # end logging }
7704 /*************************************************************************//**
7705 * @name Special pages (general and miscellaneous)
7706 * @{
7710 * Allow special page inclusions such as {{Special:Allpages}}
7712 $wgAllowSpecialInclusion = true;
7715 * Set this to an array of special page names to prevent
7716 * maintenance/updateSpecialPages.php from updating those pages.
7718 $wgDisableQueryPageUpdate = false;
7721 * On Special:Unusedimages, consider images "used", if they are put
7722 * into a category. Default (false) is not to count those as used.
7724 $wgCountCategorizedImagesAsUsed = false;
7727 * Maximum number of links to a redirect page listed on
7728 * Special:Whatlinkshere/RedirectDestination
7730 $wgMaxRedirectLinksRetrieved = 500;
7732 /** @} */ # end special pages }
7734 /*************************************************************************//**
7735 * @name Actions
7736 * @{
7740 * Array of allowed values for the "title=foo&action=<action>" parameter. Syntax is:
7741 * 'foo' => 'ClassName' Load the specified class which subclasses Action
7742 * 'foo' => true Load the class FooAction which subclasses Action
7743 * If something is specified in the getActionOverrides()
7744 * of the relevant Page object it will be used
7745 * instead of the default class.
7746 * 'foo' => false The action is disabled; show an error message
7747 * Unsetting core actions will probably cause things to complain loudly.
7749 $wgActions = [
7750 'credits' => true,
7751 'delete' => true,
7752 'edit' => true,
7753 'editchangetags' => 'SpecialPageAction',
7754 'history' => true,
7755 'info' => true,
7756 'markpatrolled' => true,
7757 'protect' => true,
7758 'purge' => true,
7759 'raw' => true,
7760 'render' => true,
7761 'revert' => true,
7762 'revisiondelete' => 'SpecialPageAction',
7763 'rollback' => true,
7764 'submit' => true,
7765 'unprotect' => true,
7766 'unwatch' => true,
7767 'view' => true,
7768 'watch' => true,
7771 /** @} */ # end actions }
7773 /*************************************************************************//**
7774 * @name Robot (search engine crawler) policy
7775 * See also $wgNoFollowLinks.
7776 * @{
7780 * Default robot policy. The default policy is to encourage indexing and fol-
7781 * lowing of links. It may be overridden on a per-namespace and/or per-page
7782 * basis.
7784 $wgDefaultRobotPolicy = 'index,follow';
7787 * Robot policies per namespaces. The default policy is given above, the array
7788 * is made of namespace constants as defined in includes/Defines.php. You can-
7789 * not specify a different default policy for NS_SPECIAL: it is always noindex,
7790 * nofollow. This is because a number of special pages (e.g., ListPages) have
7791 * many permutations of options that display the same data under redundant
7792 * URLs, so search engine spiders risk getting lost in a maze of twisty special
7793 * pages, all alike, and never reaching your actual content.
7795 * @par Example:
7796 * @code
7797 * $wgNamespaceRobotPolicies = [ NS_TALK => 'noindex' ];
7798 * @endcode
7800 $wgNamespaceRobotPolicies = [];
7803 * Robot policies per article. These override the per-namespace robot policies.
7804 * Must be in the form of an array where the key part is a properly canonicalised
7805 * text form title and the value is a robot policy.
7807 * @par Example:
7808 * @code
7809 * $wgArticleRobotPolicies = [
7810 * 'Main Page' => 'noindex,follow',
7811 * 'User:Bob' => 'index,follow',
7812 * ];
7813 * @endcode
7815 * @par Example that DOES NOT WORK because the names are not canonical text
7816 * forms:
7817 * @code
7818 * $wgArticleRobotPolicies = [
7819 * # Underscore, not space!
7820 * 'Main_Page' => 'noindex,follow',
7821 * # "Project", not the actual project name!
7822 * 'Project:X' => 'index,follow',
7823 * # Needs to be "Abc", not "abc" (unless $wgCapitalLinks is false for that namespace)!
7824 * 'abc' => 'noindex,nofollow'
7825 * ];
7826 * @endcode
7828 $wgArticleRobotPolicies = [];
7831 * An array of namespace keys in which the __INDEX__/__NOINDEX__ magic words
7832 * will not function, so users can't decide whether pages in that namespace are
7833 * indexed by search engines. If set to null, default to $wgContentNamespaces.
7835 * @par Example:
7836 * @code
7837 * $wgExemptFromUserRobotsControl = [ NS_MAIN, NS_TALK, NS_PROJECT ];
7838 * @endcode
7840 $wgExemptFromUserRobotsControl = null;
7842 /** @} */ # End robot policy }
7844 /************************************************************************//**
7845 * @name AJAX and API
7846 * Note: The AJAX entry point which this section refers to is gradually being
7847 * replaced by the API entry point, api.php. They are essentially equivalent.
7848 * Both of them are used for dynamic client-side features, via XHR.
7849 * @{
7853 * Enable the MediaWiki API for convenient access to
7854 * machine-readable data via api.php
7856 * See https://www.mediawiki.org/wiki/API
7858 $wgEnableAPI = true;
7861 * Allow the API to be used to perform write operations
7862 * (page edits, rollback, etc.) when an authorised user
7863 * accesses it
7865 $wgEnableWriteAPI = true;
7869 * WARNING: SECURITY THREAT - debug use only
7871 * Disables many security checks in the API for debugging purposes.
7872 * This flag should never be used on the production servers, as it introduces
7873 * a number of potential security holes. Even when enabled, the validation
7874 * will still be performed, but instead of failing, API will return a warning.
7875 * Also, there will always be a warning notifying that this flag is set.
7876 * At this point, the flag allows GET requests to go through for modules
7877 * requiring POST.
7879 * @since 1.21
7881 $wgDebugAPI = false;
7884 * API module extensions.
7886 * Associative array mapping module name to modules specs;
7887 * Each module spec is an associative array containing at least
7888 * the 'class' key for the module's class, and optionally a
7889 * 'factory' key for the factory function to use for the module.
7891 * That factory function will be called with two parameters,
7892 * the parent module (an instance of ApiBase, usually ApiMain)
7893 * and the name the module was registered under. The return
7894 * value must be an instance of the class given in the 'class'
7895 * field.
7897 * For backward compatibility, the module spec may also be a
7898 * simple string containing the module's class name. In that
7899 * case, the class' constructor will be called with the parent
7900 * module and module name as parameters, as described above.
7902 * Examples for registering API modules:
7904 * @code
7905 * $wgAPIModules['foo'] = 'ApiFoo';
7906 * $wgAPIModules['bar'] = [
7907 * 'class' => 'ApiBar',
7908 * 'factory' => function( $main, $name ) { ... }
7909 * ];
7910 * $wgAPIModules['xyzzy'] = [
7911 * 'class' => 'ApiXyzzy',
7912 * 'factory' => [ 'XyzzyFactory', 'newApiModule' ]
7913 * ];
7914 * @endcode
7916 * Extension modules may override the core modules.
7917 * See ApiMain::$Modules for a list of the core modules.
7919 $wgAPIModules = [];
7922 * API format module extensions.
7923 * Associative array mapping format module name to module specs (see $wgAPIModules).
7924 * Extension modules may override the core modules.
7926 * See ApiMain::$Formats for a list of the core format modules.
7928 $wgAPIFormatModules = [];
7931 * API Query meta module extensions.
7932 * Associative array mapping meta module name to module specs (see $wgAPIModules).
7933 * Extension modules may override the core modules.
7935 * See ApiQuery::$QueryMetaModules for a list of the core meta modules.
7937 $wgAPIMetaModules = [];
7940 * API Query prop module extensions.
7941 * Associative array mapping prop module name to module specs (see $wgAPIModules).
7942 * Extension modules may override the core modules.
7944 * See ApiQuery::$QueryPropModules for a list of the core prop modules.
7946 $wgAPIPropModules = [];
7949 * API Query list module extensions.
7950 * Associative array mapping list module name to module specs (see $wgAPIModules).
7951 * Extension modules may override the core modules.
7953 * See ApiQuery::$QueryListModules for a list of the core list modules.
7955 $wgAPIListModules = [];
7958 * Maximum amount of rows to scan in a DB query in the API
7959 * The default value is generally fine
7961 $wgAPIMaxDBRows = 5000;
7964 * The maximum size (in bytes) of an API result.
7965 * @warning Do not set this lower than $wgMaxArticleSize*1024
7967 $wgAPIMaxResultSize = 8388608;
7970 * The maximum number of uncached diffs that can be retrieved in one API
7971 * request. Set this to 0 to disable API diffs altogether
7973 $wgAPIMaxUncachedDiffs = 1;
7976 * Maximum amount of DB lag on a majority of DB replica DBs to tolerate
7977 * before forcing bots to retry any write requests via API errors.
7978 * This should be lower than the 'max lag' value in $wgLBFactoryConf.
7980 $wgAPIMaxLagThreshold = 7;
7983 * Log file or URL (TCP or UDP) to log API requests to, or false to disable
7984 * API request logging
7986 $wgAPIRequestLog = false;
7989 * Set the timeout for the API help text cache. If set to 0, caching disabled
7991 $wgAPICacheHelpTimeout = 60 * 60;
7994 * The ApiQueryQueryPages module should skip pages that are redundant to true
7995 * API queries.
7997 $wgAPIUselessQueryPages = [
7998 'MIMEsearch', // aiprop=mime
7999 'LinkSearch', // list=exturlusage
8000 'FileDuplicateSearch', // prop=duplicatefiles
8004 * Enable AJAX framework
8006 $wgUseAjax = true;
8009 * List of Ajax-callable functions.
8010 * Extensions acting as Ajax callbacks must register here
8011 * @deprecated (officially) since 1.27; use the API instead
8013 $wgAjaxExportList = [];
8016 * Enable AJAX check for file overwrite, pre-upload
8018 $wgAjaxUploadDestCheck = true;
8021 * Enable previewing licences via AJAX. Also requires $wgEnableAPI to be true.
8023 $wgAjaxLicensePreview = true;
8026 * Have clients send edits to be prepared when filling in edit summaries.
8027 * This gives the server a head start on the expensive parsing operation.
8029 $wgAjaxEditStash = true;
8032 * Settings for incoming cross-site AJAX requests:
8033 * Newer browsers support cross-site AJAX when the target resource allows requests
8034 * from the origin domain by the Access-Control-Allow-Origin header.
8035 * This is currently only used by the API (requests to api.php)
8036 * $wgCrossSiteAJAXdomains can be set using a wildcard syntax:
8038 * - '*' matches any number of characters
8039 * - '?' matches any 1 character
8041 * @par Example:
8042 * @code
8043 * $wgCrossSiteAJAXdomains = [
8044 * 'www.mediawiki.org',
8045 * '*.wikipedia.org',
8046 * '*.wikimedia.org',
8047 * '*.wiktionary.org',
8048 * ];
8049 * @endcode
8051 $wgCrossSiteAJAXdomains = [];
8054 * Domains that should not be allowed to make AJAX requests,
8055 * even if they match one of the domains allowed by $wgCrossSiteAJAXdomains
8056 * Uses the same syntax as $wgCrossSiteAJAXdomains
8058 $wgCrossSiteAJAXdomainExceptions = [];
8060 /** @} */ # End AJAX and API }
8062 /************************************************************************//**
8063 * @name Shell and process control
8064 * @{
8068 * Maximum amount of virtual memory available to shell processes under linux, in KB.
8070 $wgMaxShellMemory = 307200;
8073 * Maximum file size created by shell processes under linux, in KB
8074 * ImageMagick convert for example can be fairly hungry for scratch space
8076 $wgMaxShellFileSize = 102400;
8079 * Maximum CPU time in seconds for shell processes under Linux
8081 $wgMaxShellTime = 180;
8084 * Maximum wall clock time (i.e. real time, of the kind the clock on the wall
8085 * would measure) in seconds for shell processes under Linux
8087 $wgMaxShellWallClockTime = 180;
8090 * Under Linux: a cgroup directory used to constrain memory usage of shell
8091 * commands. The directory must be writable by the user which runs MediaWiki.
8093 * If specified, this is used instead of ulimit, which is inaccurate, and
8094 * causes malloc() to return NULL, which exposes bugs in C applications, making
8095 * them segfault or deadlock.
8097 * A wrapper script will create a cgroup for each shell command that runs, as
8098 * a subgroup of the specified cgroup. If the memory limit is exceeded, the
8099 * kernel will send a SIGKILL signal to a process in the subgroup.
8101 * @par Example:
8102 * @code
8103 * mkdir -p /sys/fs/cgroup/memory/mediawiki
8104 * mkdir -m 0777 /sys/fs/cgroup/memory/mediawiki/job
8105 * echo '$wgShellCgroup = "/sys/fs/cgroup/memory/mediawiki/job";' >> LocalSettings.php
8106 * @endcode
8108 * The reliability of cgroup cleanup can be improved by installing a
8109 * notify_on_release script in the root cgroup, see e.g.
8110 * https://gerrit.wikimedia.org/r/#/c/40784
8112 $wgShellCgroup = false;
8115 * Executable path of the PHP cli binary (php/php5). Should be set up on install.
8117 $wgPhpCli = '/usr/bin/php';
8120 * Locale for LC_CTYPE, to work around https://bugs.php.net/bug.php?id=45132
8121 * For Unix-like operating systems, set this to to a locale that has a UTF-8
8122 * character set. Only the character set is relevant.
8124 $wgShellLocale = 'en_US.utf8';
8126 /** @} */ # End shell }
8128 /************************************************************************//**
8129 * @name HTTP client
8130 * @{
8134 * Timeout for HTTP requests done internally, in seconds.
8136 $wgHTTPTimeout = 25;
8139 * Timeout for HTTP requests done internally for transwiki imports, in seconds.
8140 * @since 1.29
8142 $wgHTTPImportTimeout = 25;
8145 * Timeout for Asynchronous (background) HTTP requests, in seconds.
8147 $wgAsyncHTTPTimeout = 25;
8150 * Proxy to use for CURL requests.
8152 $wgHTTPProxy = false;
8155 * Local virtual hosts.
8157 * This lists domains that are configured as virtual hosts on the same machine.
8158 * If a request is to be made to a domain listed here, or any subdomain thereof,
8159 * then no proxy will be used.
8160 * Command-line scripts are not affected by this setting and will always use
8161 * proxy if it is configured.
8162 * @since 1.25
8164 $wgLocalVirtualHosts = [];
8167 * Timeout for connections done internally (in seconds)
8168 * Only works for curl
8170 $wgHTTPConnectTimeout = 5e0;
8172 /** @} */ # End HTTP client }
8174 /************************************************************************//**
8175 * @name Job queue
8176 * @{
8180 * Number of jobs to perform per request. May be less than one in which case
8181 * jobs are performed probabalistically. If this is zero, jobs will not be done
8182 * during ordinary apache requests. In this case, maintenance/runJobs.php should
8183 * be run periodically.
8185 $wgJobRunRate = 1;
8188 * When $wgJobRunRate > 0, try to run jobs asynchronously, spawning a new process
8189 * to handle the job execution, instead of blocking the request until the job
8190 * execution finishes.
8192 * @since 1.23
8194 $wgRunJobsAsync = false;
8197 * Number of rows to update per job
8199 $wgUpdateRowsPerJob = 300;
8202 * Number of rows to update per query
8204 $wgUpdateRowsPerQuery = 100;
8206 /** @} */ # End job queue }
8208 /************************************************************************//**
8209 * @name Miscellaneous
8210 * @{
8214 * Name of the external diff engine to use. Supported values:
8215 * * string: path to an external diff executable
8216 * * false: wikidiff2 PHP/HHVM module if installed, otherwise the default PHP implementation
8217 * * 'wikidiff', 'wikidiff2', and 'wikidiff3' are treated as false for backwards compatibility
8219 $wgExternalDiffEngine = false;
8222 * Disable redirects to special pages and interwiki redirects, which use a 302
8223 * and have no "redirected from" link.
8225 * @note This is only for articles with #REDIRECT in them. URL's containing a
8226 * local interwiki prefix (or a non-canonical special page name) are still hard
8227 * redirected regardless of this setting.
8229 $wgDisableHardRedirects = false;
8232 * LinkHolderArray batch size
8233 * For debugging
8235 $wgLinkHolderBatchSize = 1000;
8238 * By default MediaWiki does not register links pointing to same server in
8239 * externallinks dataset, use this value to override:
8241 $wgRegisterInternalExternals = false;
8244 * Maximum number of pages to move at once when moving subpages with a page.
8246 $wgMaximumMovedPages = 100;
8249 * Fix double redirects after a page move.
8250 * Tends to conflict with page move vandalism, use only on a private wiki.
8252 $wgFixDoubleRedirects = false;
8255 * Allow redirection to another page when a user logs in.
8256 * To enable, set to a string like 'Main Page'
8258 $wgRedirectOnLogin = null;
8261 * Configuration for processing pool control, for use in high-traffic wikis.
8262 * An implementation is provided in the PoolCounter extension.
8264 * This configuration array maps pool types to an associative array. The only
8265 * defined key in the associative array is "class", which gives the class name.
8266 * The remaining elements are passed through to the class as constructor
8267 * parameters.
8269 * @par Example using local redis instance:
8270 * @code
8271 * $wgPoolCounterConf = [ 'ArticleView' => [
8272 * 'class' => 'PoolCounterRedis',
8273 * 'timeout' => 15, // wait timeout in seconds
8274 * 'workers' => 1, // maximum number of active threads in each pool
8275 * 'maxqueue' => 5, // maximum number of total threads in each pool
8276 * 'servers' => [ '127.0.0.1' ],
8277 * 'redisConfig' => []
8278 * ] ];
8279 * @endcode
8281 * @par Example using C daemon from https://www.mediawiki.org/wiki/Extension:PoolCounter:
8282 * @code
8283 * $wgPoolCounterConf = [ 'ArticleView' => [
8284 * 'class' => 'PoolCounter_Client',
8285 * 'timeout' => 15, // wait timeout in seconds
8286 * 'workers' => 5, // maximum number of active threads in each pool
8287 * 'maxqueue' => 50, // maximum number of total threads in each pool
8288 * ... any extension-specific options...
8289 * ] ];
8290 * @endcode
8292 $wgPoolCounterConf = null;
8295 * To disable file delete/restore temporarily
8297 $wgUploadMaintenance = false;
8300 * Associative array mapping namespace IDs to the name of the content model pages in that namespace
8301 * should have by default (use the CONTENT_MODEL_XXX constants). If no special content type is
8302 * defined for a given namespace, pages in that namespace will use the CONTENT_MODEL_WIKITEXT
8303 * (except for the special case of JS and CS pages).
8305 * @since 1.21
8307 $wgNamespaceContentModels = [];
8310 * How to react if a plain text version of a non-text Content object is requested using
8311 * ContentHandler::getContentText():
8313 * * 'ignore': return null
8314 * * 'fail': throw an MWException
8315 * * 'serialize': serialize to default format
8317 * @since 1.21
8319 $wgContentHandlerTextFallback = 'ignore';
8322 * Set to false to disable use of the database fields introduced by the ContentHandler facility.
8323 * This way, the ContentHandler facility can be used without any additional information in the
8324 * database. A page's content model is then derived solely from the page's title. This however
8325 * means that changing a page's default model (e.g. using $wgNamespaceContentModels) will break
8326 * the page and/or make the content inaccessible. This also means that pages can not be moved to
8327 * a title that would default to a different content model.
8329 * Overall, with $wgContentHandlerUseDB = false, no database updates are needed, but content
8330 * handling is less robust and less flexible.
8332 * @since 1.21
8334 $wgContentHandlerUseDB = true;
8337 * Determines which types of text are parsed as wikitext. This does not imply that these kinds
8338 * of texts are also rendered as wikitext, it only means that links, magic words, etc will have
8339 * the effect on the database they would have on a wikitext page.
8341 * @todo On the long run, it would be nice to put categories etc into a separate structure,
8342 * or at least parse only the contents of comments in the scripts.
8344 * @since 1.21
8346 $wgTextModelsToParse = [
8347 CONTENT_MODEL_WIKITEXT, // Just for completeness, wikitext will always be parsed.
8348 CONTENT_MODEL_JAVASCRIPT, // Make categories etc work, people put them into comments.
8349 CONTENT_MODEL_CSS, // Make categories etc work, people put them into comments.
8353 * Register handlers for specific types of sites.
8355 * @since 1.20
8357 $wgSiteTypes = [
8358 'mediawiki' => 'MediaWikiSite',
8362 * Whether the page_props table has a pp_sortkey column. Set to false in case
8363 * the respective database schema change was not applied.
8364 * @since 1.23
8366 $wgPagePropsHaveSortkey = true;
8369 * Port where you have HTTPS running
8370 * Supports HTTPS on non-standard ports
8371 * @see bug 65184
8372 * @since 1.24
8374 $wgHttpsPort = 443;
8377 * Secret for session storage.
8378 * This should be set in LocalSettings.php, otherwise wgSecretKey will
8379 * be used.
8380 * @since 1.27
8382 $wgSessionSecret = false;
8385 * If for some reason you can't install the PHP OpenSSL or mcrypt extensions,
8386 * you can set this to true to make MediaWiki work again at the cost of storing
8387 * sensitive session data insecurely. But it would be much more secure to just
8388 * install the OpenSSL extension.
8389 * @since 1.27
8391 $wgSessionInsecureSecrets = false;
8394 * Secret for hmac-based key derivation function (fast,
8395 * cryptographically secure random numbers).
8396 * This should be set in LocalSettings.php, otherwise wgSecretKey will
8397 * be used.
8398 * See also: $wgHKDFAlgorithm
8399 * @since 1.24
8401 $wgHKDFSecret = false;
8404 * Algorithm for hmac-based key derivation function (fast,
8405 * cryptographically secure random numbers).
8406 * See also: $wgHKDFSecret
8407 * @since 1.24
8409 $wgHKDFAlgorithm = 'sha256';
8412 * Enable page language feature
8413 * Allows setting page language in database
8414 * @var bool
8415 * @since 1.24
8417 $wgPageLanguageUseDB = false;
8420 * Global configuration variable for Virtual REST Services.
8422 * Use the 'path' key to define automatically mounted services. The value for this
8423 * key is a map of path prefixes to service configuration. The latter is an array of:
8424 * - class : the fully qualified class name
8425 * - options : map of arguments to the class constructor
8426 * Such services will be available to handle queries under their path from the VRS
8427 * singleton, e.g. MediaWikiServices::getInstance()->getVirtualRESTServiceClient();
8429 * Auto-mounting example for Parsoid:
8431 * $wgVirtualRestConfig['paths']['/parsoid/'] = [
8432 * 'class' => 'ParsoidVirtualRESTService',
8433 * 'options' => [
8434 * 'url' => 'http://localhost:8000',
8435 * 'prefix' => 'enwiki',
8436 * 'domain' => 'en.wikipedia.org'
8438 * ];
8440 * Parameters for different services can also be declared inside the 'modules' value,
8441 * which is to be treated as an associative array. The parameters in 'global' will be
8442 * merged with service-specific ones. The result will then be passed to
8443 * VirtualRESTService::__construct() in the module.
8445 * Example config for Parsoid:
8447 * $wgVirtualRestConfig['modules']['parsoid'] = [
8448 * 'url' => 'http://localhost:8000',
8449 * 'prefix' => 'enwiki',
8450 * 'domain' => 'en.wikipedia.org',
8451 * ];
8453 * @var array
8454 * @since 1.25
8456 $wgVirtualRestConfig = [
8457 'paths' => [],
8458 'modules' => [],
8459 'global' => [
8460 # Timeout in seconds
8461 'timeout' => 360,
8462 # 'domain' is set to $wgCanonicalServer in Setup.php
8463 'forwardCookies' => false,
8464 'HTTPProxy' => null
8469 * Controls whether zero-result search queries with suggestions should display results for
8470 * these suggestions.
8472 * @var bool
8473 * @since 1.26
8475 $wgSearchRunSuggestedQuery = true;
8478 * Where popular password file is located.
8480 * Default in core contains 10,000 most popular. This config
8481 * allows you to change which file, in case you want to generate
8482 * a password file with > 10000 entries in it.
8484 * @see maintenance/createCommonPasswordCdb.php
8485 * @since 1.27
8486 * @var string path to file
8488 $wgPopularPasswordFile = __DIR__ . '/../serialized/commonpasswords.cdb';
8491 * Max time (in seconds) a user-generated transaction can spend in writes.
8492 * If exceeded, the transaction is rolled back with an error instead of being committed.
8494 * @var int|bool Disabled if false
8495 * @since 1.27
8497 $wgMaxUserDBWriteDuration = false;
8500 * Mapping of event channels (or channel categories) to EventRelayer configuration.
8502 * By setting up a PubSub system (like Kafka) and enabling a corresponding EventRelayer class
8503 * that uses it, MediaWiki can broadcast events to all subscribers. Certain features like WAN
8504 * cache purging and CDN cache purging will emit events to this system. Appropriate listers can
8505 * subscribe to the channel and take actions based on the events. For example, a local daemon
8506 * can run on each CDN cache node and perfom local purges based on the URL purge channel events.
8508 * Some extensions may want to use "channel categories" so that different channels can also share
8509 * the same custom relayer instance (e.g. when it's likely to be overriden). They can use
8510 * EventRelayerGroup::getRelayer() based on the category but call notify() on various different
8511 * actual channels. One reason for this would be that some system have very different performance
8512 * vs durability needs, so one system (e.g. Kafka) may not be suitable for all uses.
8514 * The 'default' key is for all channels (or channel categories) without an explicit entry here.
8516 * @since 1.27
8518 $wgEventRelayerConfig = [
8519 'default' => [
8520 'class' => 'EventRelayerNull',
8525 * Share data about this installation with MediaWiki developers
8527 * When set to true, MediaWiki will periodically ping https://www.mediawiki.org/ with basic
8528 * data about this MediaWiki instance. This data includes, for example, the type of system,
8529 * PHP version, and chosen database backend. The Wikimedia Foundation shares this data with
8530 * MediaWiki developers to help guide future development efforts.
8532 * For details about what data is sent, see: https://www.mediawiki.org/wiki/Manual:$wgPingback
8534 * @var bool
8535 * @since 1.28
8537 $wgPingback = false;
8540 * List of urls which appear often to be triggering CSP reports
8541 * but do not appear to be caused by actual content, but by client
8542 * software inserting scripts (i.e. Ad-Ware).
8543 * List based on results from Wikimedia logs.
8545 * @since 1.28
8547 $wgCSPFalsePositiveUrls = [
8548 'https://3hub.co' => true,
8549 'https://morepro.info' => true,
8550 'https://p.ato.mx' => true,
8551 'https://s.ato.mx' => true,
8552 'https://adserver.adtech.de' => true,
8553 'https://ums.adtechus.com' => true,
8554 'https://cas.criteo.com' => true,
8555 'https://cat.nl.eu.criteo.com' => true,
8556 'https://atpixel.alephd.com' => true,
8557 'https://rtb.metrigo.com' => true,
8558 'https://d5p.de17a.com' => true,
8562 * The following variables define 3 user experience levels:
8564 * - newcomer: has not yet reached the 'learner' level
8566 * - learner: has at least $wgLearnerEdits and has been
8567 * a member for $wgLearnerMemberSince days
8568 * but has not yet reached the 'experienced' level.
8570 * - experienced: has at least $wgExperiencedUserEdits edits and
8571 * has been a member for $wgExperiencedUserMemberSince days.
8573 $wgLearnerEdits = 10;
8574 $wgLearnerMemberSince = 4; # days
8575 $wgExperiencedUserEdits = 500;
8576 $wgExperiencedUserMemberSince = 30; # days
8579 * Mapping of interwiki index prefixes to descriptors that
8580 * can be used to change the display of interwiki search results.
8582 * Descriptors are appended to CSS classes of interwiki results
8583 * which using InterwikiSearchResultWidget.
8585 * Predefined descriptors include the following words:
8586 * definition, textbook, news, quotation, book, travel, course
8588 * @par Example:
8589 * @code
8590 * $wgInterwikiPrefixDisplayTypes = [
8591 * 'iwprefix' => 'definition'
8593 * @endcode
8595 $wgInterwikiPrefixDisplayTypes = [];
8598 * For really cool vim folding this needs to be at the end:
8599 * vim: foldmarker=@{,@} foldmethod=marker
8600 * @}