3 * Default values for MediaWiki configuration settings.
9 * To customize your installation, edit "LocalSettings.php". If you make
10 * changes here, they will be lost on next upgrade of MediaWiki!
12 * In this file, variables whose default values depend on other
13 * variables are set to false. The actual default value of these variables
14 * will only be set in Setup.php, taking into account any custom settings
15 * performed in LocalSettings.php.
17 * Documentation is in the source and on:
18 * https://www.mediawiki.org/wiki/Manual:Configuration_settings
20 * @warning Note: this (and other things) will break if the autoloader is not
21 * enabled. Please include includes/AutoLoader.php before including this file.
23 * This program is free software; you can redistribute it and/or modify
24 * it under the terms of the GNU General Public License as published by
25 * the Free Software Foundation; either version 2 of the License, or
26 * (at your option) any later version.
28 * This program is distributed in the hope that it will be useful,
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31 * GNU General Public License for more details.
33 * You should have received a copy of the GNU General Public License along
34 * with this program; if not, write to the Free Software Foundation, Inc.,
35 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
36 * http://www.gnu.org/copyleft/gpl.html
42 * @defgroup Globalsettings Global settings
46 * @cond file_level_code
47 * This is not a valid entry point, perform no further processing unless
48 * MEDIAWIKI is defined
50 if ( !defined( 'MEDIAWIKI' ) ) {
51 echo "This file is part of MediaWiki and is not a valid entry point\n";
58 * wgConf hold the site configuration.
59 * Not used for much in a default install.
62 $wgConf = new SiteConfiguration
;
65 * Registry of factory functions to create config objects:
66 * The 'main' key must be set, and the value should be a valid
71 'main' => 'GlobalVarConfig::newInstance'
75 * MediaWiki version number
78 $wgVersion = '1.30.0-alpha';
81 * Name of the site. It must be changed in LocalSettings.php
83 $wgSitename = 'MediaWiki';
86 * When the wiki is running behind a proxy and this is set to true, assumes that the proxy exposes
87 * the wiki on the standard ports (443 for https and 80 for http).
91 $wgAssumeProxiesUseDefaultProtocolPorts = true;
98 * $wgServer = 'http://example.com';
101 * This is usually detected correctly by MediaWiki. If MediaWiki detects the
102 * wrong server, it will redirect incorrectly after you save a page. In that
103 * case, set this variable to fix it.
105 * If you want to use protocol-relative URLs on your wiki, set this to a
106 * protocol-relative URL like '//example.com' and set $wgCanonicalServer
107 * to a fully qualified URL.
109 $wgServer = WebRequest
::detectServer();
112 * Canonical URL of the server, to use in IRC feeds and notification e-mails.
113 * Must be fully qualified, even if $wgServer is protocol-relative.
115 * Defaults to $wgServer, expanded to a fully qualified http:// URL if needed.
118 $wgCanonicalServer = false;
121 * Server name. This is automatically computed by parsing the bare
122 * hostname out of $wgCanonicalServer. It should not be customized.
125 $wgServerName = false;
127 /************************************************************************//**
128 * @name Script path settings
133 * The path we should point to.
134 * It might be a virtual path in case with use apache mod_rewrite for example.
136 * This *needs* to be set correctly.
138 * Other paths will be set to defaults based on it unless they are directly
139 * set in LocalSettings.php
141 $wgScriptPath = '/wiki';
144 * Whether to support URLs like index.php/Page_title These often break when PHP
145 * is set up in CGI mode. PATH_INFO *may* be correct if cgi.fix_pathinfo is set,
146 * but then again it may not; lighttpd converts incoming path data to lowercase
147 * on systems with case-insensitive filesystems, and there have been reports of
148 * problems on Apache as well.
150 * To be safe we'll continue to keep it off by default.
152 * Override this to false if $_SERVER['PATH_INFO'] contains unexpectedly
153 * incorrect garbage, or to true if it is really correct.
155 * The default $wgArticlePath will be set based on this value at runtime, but if
156 * you have customized it, having this incorrectly set to true can cause
157 * redirect loops when "pretty URLs" are used.
160 $wgUsePathInfo = ( strpos( PHP_SAPI
, 'cgi' ) === false ) &&
161 ( strpos( PHP_SAPI
, 'apache2filter' ) === false ) &&
162 ( strpos( PHP_SAPI
, 'isapi' ) === false );
165 * The extension to append to script names by default.
167 * Some hosting providers used PHP 4 for *.php files, and PHP 5 for *.php5.
168 * This variable was provided to support those providers.
171 * @deprecated since 1.25; support for '.php5' has been phased out of MediaWiki
172 * proper. Backward-compatibility can be maintained by configuring your web
173 * server to rewrite URLs. See RELEASE-NOTES for details.
175 $wgScriptExtension = '.php';
179 /************************************************************************//**
180 * @name URLs and file paths
182 * These various web and file path variables are set to their defaults
183 * in Setup.php if they are not explicitly set from LocalSettings.php.
185 * These will relatively rarely need to be set manually, unless you are
186 * splitting style sheets or images outside the main document root.
188 * In this section, a "path" is usually a host-relative URL, i.e. a URL without
189 * the host part, that starts with a slash. In most cases a full URL is also
190 * acceptable. A "directory" is a local file path.
192 * In both paths and directories, trailing slashes should not be included.
198 * The URL path to index.php.
200 * Defaults to "{$wgScriptPath}/index.php".
205 * The URL path to load.php.
207 * Defaults to "{$wgScriptPath}/load.php".
210 $wgLoadScript = false;
213 * The URL path of the skins directory.
214 * Defaults to "{$wgResourceBasePath}/skins".
217 $wgStylePath = false;
218 $wgStyleSheetPath = &$wgStylePath;
221 * The URL path of the skins directory. Should not point to an external domain.
222 * Defaults to "{$wgScriptPath}/skins".
225 $wgLocalStylePath = false;
228 * The URL path of the extensions directory.
229 * Defaults to "{$wgResourceBasePath}/extensions".
232 $wgExtensionAssetsPath = false;
235 * Filesystem extensions directory.
236 * Defaults to "{$IP}/extensions".
239 $wgExtensionDirectory = "{$IP}/extensions";
242 * Filesystem stylesheets directory.
243 * Defaults to "{$IP}/skins".
246 $wgStyleDirectory = "{$IP}/skins";
249 * The URL path for primary article page views. This path should contain $1,
250 * which is replaced by the article title.
252 * Defaults to "{$wgScript}/$1" or "{$wgScript}?title=$1",
253 * depending on $wgUsePathInfo.
255 $wgArticlePath = false;
258 * The URL path for the images directory.
259 * Defaults to "{$wgScriptPath}/images".
261 $wgUploadPath = false;
264 * The filesystem path of the images directory. Defaults to "{$IP}/images".
266 $wgUploadDirectory = false;
269 * Directory where the cached page will be saved.
270 * Defaults to "{$wgUploadDirectory}/cache".
272 $wgFileCacheDirectory = false;
275 * The URL path of the wiki logo. The logo size should be 135x135 pixels.
276 * Defaults to "$wgResourceBasePath/resources/assets/wiki.png".
281 * Array with URL paths to HD versions of the wiki logo. The scaled logo size
282 * should be under 135x155 pixels.
283 * Only 1.5x and 2x versions are supported.
288 * "1.5x" => "path/to/1.5x_version.png",
289 * "2x" => "path/to/2x_version.png"
298 * The URL path of the shortcut icon.
301 $wgFavicon = '/favicon.ico';
304 * The URL path of the icon for iPhone and iPod Touch web app bookmarks.
305 * Defaults to no icon.
308 $wgAppleTouchIcon = false;
311 * Value for the referrer policy meta tag.
312 * One of 'never', 'default', 'origin', 'always'. Setting it to false just
313 * prevents the meta tag from being output.
314 * See https://www.w3.org/TR/referrer-policy/ for details.
318 $wgReferrerPolicy = false;
321 * The local filesystem path to a temporary directory. This is not required to
324 * When this setting is set to false, its value will be set through a call
325 * to wfTempDir(). See that methods implementation for the actual detection
328 * Developers should use the global function wfTempDir() instead of this
332 * @note Default changed to false in MediaWiki 1.20.
334 $wgTmpDirectory = false;
337 * If set, this URL is added to the start of $wgUploadPath to form a complete
341 $wgUploadBaseUrl = '';
344 * To enable remote on-demand scaling, set this to the thumbnail base URL.
345 * Full thumbnail URL will be like $wgUploadStashScalerBaseUrl/e/e6/Foo.jpg/123px-Foo.jpg
346 * where 'e6' are the first two characters of the MD5 hash of the file name.
347 * If $wgUploadStashScalerBaseUrl is set to false, thumbs are rendered locally as needed.
350 $wgUploadStashScalerBaseUrl = false;
353 * To set 'pretty' URL paths for actions other than
354 * plain page views, add to this array.
357 * Set pretty URL for the edit action:
359 * 'edit' => "$wgScriptPath/edit/$1"
362 * There must be an appropriate script or rewrite rule in place to handle these
370 /************************************************************************//**
371 * @name Files and file uploads
376 * Uploads have to be specially set up to be secure
378 $wgEnableUploads = false;
381 * The maximum age of temporary (incomplete) uploaded files
383 $wgUploadStashMaxAge = 6 * 3600; // 6 hours
386 * Allows to move images and other media files
388 $wgAllowImageMoving = true;
391 * Enable deferred upload tasks that use the job queue.
392 * Only enable this if job runners are set up for both the
393 * 'AssembleUploadChunks' and 'PublishStashedFile' job types.
395 * @note If you use suhosin, this setting is incompatible with
396 * suhosin.session.encrypt.
398 $wgEnableAsyncUploads = false;
401 * Additional characters that are not allowed in filenames. They are replaced with '-' when
402 * uploading. Like $wgLegalTitleChars, this is a regexp character class.
404 * Slashes and backslashes are disallowed regardless of this setting, but included here for
407 $wgIllegalFileChars = ":\\/\\\\";
410 * What directory to place deleted uploads in.
411 * Defaults to "{$wgUploadDirectory}/deleted".
413 $wgDeletedDirectory = false;
416 * Set this to true if you use img_auth and want the user to see details on why access failed.
418 $wgImgAuthDetails = false;
421 * Map of relative URL directories to match to internal mwstore:// base storage paths.
422 * For img_auth.php requests, everything after "img_auth.php/" is checked to see
423 * if starts with any of the prefixes defined here. The prefixes should not overlap.
424 * The prefix that matches has a corresponding storage path, which the rest of the URL
425 * is assumed to be relative to. The file at that path (or a 404) is send to the client.
428 * $wgImgAuthUrlPathMap['/timeline/'] = 'mwstore://local-fs/timeline-render/';
429 * The above maps ".../img_auth.php/timeline/X" to "mwstore://local-fs/timeline-render/".
430 * The name "local-fs" should correspond by name to an entry in $wgFileBackends.
432 * @see $wgFileBackends
434 $wgImgAuthUrlPathMap = [];
437 * File repository structures
439 * $wgLocalFileRepo is a single repository structure, and $wgForeignFileRepos is
440 * an array of such structures. Each repository structure is an associative
441 * array of properties configuring the repository.
443 * Properties required for all repos:
444 * - class The class name for the repository. May come from the core or an extension.
445 * The core repository classes are FileRepo, LocalRepo, ForeignDBRepo.
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
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
476 * - directory The local filesystem directory where public files are stored. Not used for
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.
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
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
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.
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.
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.
556 'description' => true,
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
582 // Format of the file page wikitext to be generated from the fields input by the user.
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',
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:
666 * extension=extensions/php_exif.dll
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.
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
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
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.
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
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.
770 * $wgMaxUploadSize = [
772 * 'url' => 500 * 1024,
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.
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).
795 * $wgUploadNavigationUrl = 'https://commons.wikimedia.org/wiki/Special:Upload';
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.
815 * $wgThumbnailScriptPath = "{$wgScriptPath}/thumb.php";
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/)
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.
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.
969 $wgContentHandlers = [
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
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:
1033 * $wgCustomConvertCommand = "gm convert %s -resize %wx%h %d"
1036 * Leave as false to skip this.
1038 $wgCustomConvertCommand = false;
1041 * used for lossless jpeg rotation
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
1052 * See https://en.wikipedia.org/wiki/Chroma_subsampling
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.
1066 $wgJpegPixelFormat = 'yuv420';
1069 * Some tests and extensions use exiv2 to manipulate the Exif metadata in some
1072 $wgExiv2Command = '/usr/bin/exiv2';
1075 * Path to exiftool binary. Used for lossless ICC profile swapping.
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 = [
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 '
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.
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' ];
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
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
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
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
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 = [
1269 'command' => 'clamscan --no-summary ',
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.
1311 * #$wgMimeDetectorCommand = "file -bi"; # use external MIME detector (Linux)
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
1321 $wgTrivialMimeDetection = false;
1324 * Additional XML types we can allow via MIME-detection.
1325 * array = [ 'rootElement' => 'associatedMimeType' ]
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 T10858).
1341 * This is the list of settings the user can choose from:
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:
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
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.
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
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.
1416 $wgUploadThumbnailRenderMethod = 'jobqueue';
1419 * When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom Host HTTP header.
1423 $wgUploadThumbnailRenderHttpCustomHost = false;
1426 * When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom domain to send the
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.
1439 $wgUseTinyRGBForJPGThumbnails = false;
1442 * Default parameters for the "<gallery>" tag
1444 $wgGalleryOptions = [
1445 // Default number of images per-row in the gallery. 0 -> Adapt to screensize
1446 'imagesPerRow' => 0,
1447 // Width of the cells containing images in galleries (in "px")
1448 'imageWidth' => 120,
1449 // Height of the cells containing images in galleries (in "px")
1450 'imageHeight' => 120,
1451 // Length to truncate filename to in caption when using "showfilename".
1452 // A value of 'true' will truncate the filename to one line using CSS
1453 // and will be the behaviour after deprecation.
1454 // @deprecated since 1.28
1455 'captionLength' => true,
1456 // Show the filesize in bytes in categories
1457 'showBytes' => true,
1458 'mode' => 'traditional',
1462 * Adjust width of upright images when parameter 'upright' is used
1463 * This allows a nicer look for upright images without the need to fix the width
1464 * by hardcoded px in wiki sourcecode.
1466 $wgThumbUpright = 0.75;
1469 * Default value for chmoding of new directories.
1471 $wgDirectoryMode = 0777;
1474 * Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities.
1476 * This means a 320x240 use of an image on the wiki will also generate 480x360 and 640x480
1477 * thumbnails, output via the srcset attribute.
1479 * On older browsers, a JavaScript polyfill switches the appropriate images in after loading
1480 * the original low-resolution versions depending on the reported window.devicePixelRatio.
1481 * The polyfill can be found in the jquery.hidpi module.
1483 $wgResponsiveImages = true;
1486 * @name DJVU settings
1491 * Path of the djvudump executable
1492 * Enable this and $wgDjvuRenderer to enable djvu rendering
1493 * example: $wgDjvuDump = 'djvudump';
1498 * Path of the ddjvu DJVU renderer
1499 * Enable this and $wgDjvuDump to enable djvu rendering
1500 * example: $wgDjvuRenderer = 'ddjvu';
1502 $wgDjvuRenderer = null;
1505 * Path of the djvutxt DJVU text extraction utility
1506 * Enable this and $wgDjvuDump to enable text layer extraction from djvu files
1507 * example: $wgDjvuTxt = 'djvutxt';
1512 * Path of the djvutoxml executable
1513 * This works like djvudump except much, much slower as of version 3.5.
1515 * For now we recommend you use djvudump instead. The djvuxml output is
1516 * probably more stable, so we'll switch back to it as soon as they fix
1517 * the efficiency problem.
1518 * https://sourceforge.net/tracker/index.php?func=detail&aid=1704049&group_id=32953&atid=406583
1522 * $wgDjvuToXML = 'djvutoxml';
1525 $wgDjvuToXML = null;
1528 * Shell command for the DJVU post processor
1529 * Default: pnmtojpeg, since ddjvu generates ppm output
1530 * Set this to false to output the ppm file directly.
1532 $wgDjvuPostProcessor = 'pnmtojpeg';
1535 * File extension for the DJVU post processor output
1537 $wgDjvuOutputExtension = 'jpg';
1539 /** @} */ # end of DJvu }
1541 /** @} */ # end of file uploads }
1543 /************************************************************************//**
1544 * @name Email settings
1549 * Site admin email address.
1551 * Defaults to "wikiadmin@$wgServerName".
1553 $wgEmergencyContact = false;
1556 * Sender email address for e-mail notifications.
1558 * The address we use as sender when a user requests a password reminder.
1560 * Defaults to "apache@$wgServerName".
1562 $wgPasswordSender = false;
1565 * Sender name for e-mail notifications.
1567 * @deprecated since 1.23; use the system message 'emailsender' instead.
1569 $wgPasswordSenderName = 'MediaWiki Mail';
1572 * Reply-To address for e-mail notifications.
1574 * Defaults to $wgPasswordSender.
1576 $wgNoReplyAddress = false;
1579 * Set to true to enable the e-mail basic features:
1580 * Password reminders, etc. If sending e-mail on your
1581 * server doesn't work, you might want to disable this.
1583 $wgEnableEmail = true;
1586 * Set to true to enable user-to-user e-mail.
1587 * This can potentially be abused, as it's hard to track.
1589 $wgEnableUserEmail = true;
1592 * If true put the sending user's email in a Reply-To header
1593 * instead of From (false). ($wgPasswordSender will be used as From.)
1595 * Some mailers (eg SMTP) set the SMTP envelope sender to the From value,
1596 * which can cause problems with SPF validation and leak recipient addresses
1597 * when bounces are sent to the sender. In addition, DMARC restrictions
1598 * can cause emails to fail to be received when false.
1600 $wgUserEmailUseReplyTo = true;
1603 * Minimum time, in hours, which must elapse between password reminder
1604 * emails for a given account. This is to prevent abuse by mail flooding.
1606 $wgPasswordReminderResendTime = 24;
1609 * The time, in seconds, when an emailed temporary password expires.
1611 $wgNewPasswordExpiry = 3600 * 24 * 7;
1614 * The time, in seconds, when an email confirmation email expires
1616 $wgUserEmailConfirmationTokenExpiry = 7 * 24 * 60 * 60;
1619 * The number of days that a user's password is good for. After this number of days, the
1620 * user will be asked to reset their password. Set to false to disable password expiration.
1622 $wgPasswordExpirationDays = false;
1625 * If a user's password is expired, the number of seconds when they can still login,
1626 * and cancel their password change, but are sent to the password change form on each login.
1628 $wgPasswordExpireGrace = 3600 * 24 * 7; // 7 days
1633 * For using a direct (authenticated) SMTP server connection.
1634 * Default to false or fill an array :
1638 * 'host' => 'SMTP domain',
1639 * 'IDHost' => 'domain for MessageID',
1641 * 'auth' => [true|false],
1642 * 'username' => [SMTP username],
1643 * 'password' => [SMTP password],
1650 * Additional email parameters, will be passed as the last argument to mail() call.
1652 $wgAdditionalMailParams = null;
1655 * For parts of the system that have been updated to provide HTML email content, send
1656 * both text and HTML parts as the body of the email
1658 $wgAllowHTMLEmail = false;
1661 * True: from page editor if s/he opted-in. False: Enotif mails appear to come
1662 * from $wgEmergencyContact
1664 $wgEnotifFromEditor = false;
1666 // TODO move UPO to preferences probably ?
1667 # If set to true, users get a corresponding option in their preferences and can choose to
1668 # enable or disable at their discretion
1669 # If set to false, the corresponding input form on the user preference page is suppressed
1670 # It call this to be a "user-preferences-option (UPO)"
1673 * Require email authentication before sending mail to an email address.
1674 * This is highly recommended. It prevents MediaWiki from being used as an open
1677 $wgEmailAuthentication = true;
1680 * Allow users to enable email notification ("enotif") on watchlist changes.
1682 $wgEnotifWatchlist = false;
1685 * Allow users to enable email notification ("enotif") when someone edits their
1688 * The owner of the user talk page must also have the 'enotifusertalkpages' user
1689 * preference set to true.
1691 $wgEnotifUserTalk = false;
1694 * Set the Reply-to address in notifications to the editor's address, if user
1695 * allowed this in the preferences.
1697 $wgEnotifRevealEditorAddress = false;
1700 * Potentially send notification mails on minor edits to pages. This is enabled
1701 * by default. If this is false, users will never be notified on minor edits.
1703 * If it is true, editors with the 'nominornewtalk' right (typically bots) will still not
1704 * trigger notifications for minor edits they make (to any page, not just user talk).
1706 * Finally, if the watcher/recipient has the 'enotifminoredits' user preference set to
1707 * false, they will not receive notifications for minor edits.
1709 * User talk notifications are also affected by $wgEnotifMinorEdits, the above settings,
1710 * $wgEnotifUserTalk, and the preference described there.
1712 $wgEnotifMinorEdits = true;
1715 * Send a generic mail instead of a personalised mail for each user. This
1716 * always uses UTC as the time zone, and doesn't include the username.
1718 * For pages with many users watching, this can significantly reduce mail load.
1719 * Has no effect when using sendmail rather than SMTP.
1721 $wgEnotifImpersonal = false;
1724 * Maximum number of users to mail at once when using impersonal mail. Should
1725 * match the limit on your mail server.
1727 $wgEnotifMaxRecips = 500;
1730 * Use real name instead of username in e-mail "from" field.
1732 $wgEnotifUseRealName = false;
1735 * Array of usernames who will be sent a notification email for every change
1736 * which occurs on a wiki. Users will not be notified of their own changes.
1738 $wgUsersNotifiedOnAllChanges = [];
1740 /** @} */ # end of email settings
1742 /************************************************************************//**
1743 * @name Database settings
1748 * Database host name or IP address
1750 $wgDBserver = 'localhost';
1753 * Database port number (for PostgreSQL and Microsoft SQL Server).
1758 * Name of the database
1760 $wgDBname = 'my_wiki';
1765 $wgDBuser = 'wikiuser';
1768 * Database user's password
1775 $wgDBtype = 'mysql';
1778 * Whether to use SSL in DB connection.
1780 * This setting is only used $wgLBFactoryConf['class'] is set to
1781 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
1782 * the DBO_SSL flag must be set in the 'flags' option of the database
1783 * connection to achieve the same functionality.
1788 * Whether to use compression in DB connection.
1790 * This setting is only used $wgLBFactoryConf['class'] is set to
1791 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
1792 * the DBO_COMPRESS flag must be set in the 'flags' option of the database
1793 * connection to achieve the same functionality.
1795 $wgDBcompress = false;
1798 * Separate username for maintenance tasks. Leave as null to use the default.
1800 $wgDBadminuser = null;
1803 * Separate password for maintenance tasks. Leave as null to use the default.
1805 $wgDBadminpassword = null;
1809 * Leave as null to select the default search engine for the
1810 * selected database type (eg SearchMySQL), or set to a class
1811 * name to override to a custom search engine.
1813 $wgSearchType = null;
1816 * Alternative search types
1817 * Sometimes you want to support multiple search engines for testing. This
1818 * allows users to select their search engine of choice via url parameters
1819 * to Special:Search and the action=search API. If using this, there's no
1820 * need to add $wgSearchType to it, that is handled automatically.
1822 $wgSearchTypeAlternatives = null;
1830 * MySQL table options to use during installation or update
1832 $wgDBTableOptions = 'ENGINE=InnoDB';
1835 * SQL Mode - default is turning off all modes, including strict, if set.
1836 * null can be used to skip the setting for performance reasons and assume
1837 * DBA has done his best job.
1838 * String override can be used for some additional fun :-)
1845 $wgDBmwschema = null;
1848 * To override default SQLite data directory ($docroot/../data)
1850 $wgSQLiteDataDir = '';
1853 * Shared database for multiple wikis. Commonly used for storing a user table
1854 * for single sign-on. The server for this database must be the same as for the
1857 * For backwards compatibility the shared prefix is set to the same as the local
1858 * prefix, and the user table is listed in the default list of shared tables.
1859 * The user_properties table is also added so that users will continue to have their
1860 * preferences shared (preferences were stored in the user table prior to 1.16)
1862 * $wgSharedTables may be customized with a list of tables to share in the shared
1863 * database. However it is advised to limit what tables you do share as many of
1864 * MediaWiki's tables may have side effects if you try to share them.
1866 * $wgSharedPrefix is the table prefix for the shared database. It defaults to
1869 * $wgSharedSchema is the table schema for the shared database. It defaults to
1872 * @deprecated since 1.21 In new code, use the $wiki parameter to wfGetLB() to
1873 * access remote databases. Using wfGetLB() allows the shared database to
1874 * reside on separate servers to the wiki's own database, with suitable
1875 * configuration of $wgLBFactoryConf.
1882 $wgSharedPrefix = false;
1887 $wgSharedTables = [ 'user', 'user_properties' ];
1893 $wgSharedSchema = false;
1896 * Database load balancer
1897 * This is a two-dimensional array, an array of server info structures
1900 * - dbname: Default database name
1902 * - password: DB password
1905 * - load: Ratio of DB_REPLICA load, must be >=0, the sum of all loads must be >0.
1906 * If this is zero for any given server, no normal query traffic will be
1907 * sent to it. It will be excluded from lag checks in maintenance scripts.
1908 * The only way it can receive traffic is if groupLoads is used.
1910 * - groupLoads: array of load ratios, the key is the query group name. A query may belong
1911 * to several groups, the most specific group defined here is used.
1913 * - flags: bit field
1914 * - DBO_DEFAULT -- turns on DBO_TRX only if "cliMode" is off (recommended)
1915 * - DBO_DEBUG -- equivalent of $wgDebugDumpSql
1916 * - DBO_TRX -- wrap entire request in a transaction
1917 * - DBO_NOBUFFER -- turn off buffering (not useful in LocalSettings.php)
1918 * - DBO_PERSISTENT -- enables persistent database connections
1919 * - DBO_SSL -- uses SSL/TLS encryption in database connections, if available
1920 * - DBO_COMPRESS -- uses internal compression in database connections,
1923 * - max lag: (optional) Maximum replication lag before a replica DB goes out of rotation
1924 * - is static: (optional) Set to true if the dataset is static and no replication is used.
1925 * - cliMode: (optional) Connection handles will not assume that requests are short-lived
1926 * nor that INSERT..SELECT can be rewritten into a buffered SELECT and INSERT.
1927 * [Default: uses value of $wgCommandLineMode]
1929 * These and any other user-defined properties will be assigned to the mLBInfo member
1930 * variable of the Database object.
1932 * Leave at false to use the single-server variables above. If you set this
1933 * variable, the single-server variables will generally be ignored (except
1934 * perhaps in some command-line scripts).
1936 * The first server listed in this array (with key 0) will be the master. The
1937 * rest of the servers will be replica DBs. To prevent writes to your replica DBs due to
1938 * accidental misconfiguration or MediaWiki bugs, set read_only=1 on all your
1939 * replica DBs in my.cnf. You can set read_only mode at runtime using:
1942 * SET @@read_only=1;
1945 * Since the effect of writing to a replica DB is so damaging and difficult to clean
1946 * up, we at Wikimedia set read_only=1 in my.cnf on all our DB servers, even
1947 * our masters, and then set read_only=0 on masters at runtime.
1949 $wgDBservers = false;
1952 * Load balancer factory configuration
1953 * To set up a multi-master wiki farm, set the class here to something that
1954 * can return a LoadBalancer with an appropriate master on a call to getMainLB().
1955 * The class identified here is responsible for reading $wgDBservers,
1956 * $wgDBserver, etc., so overriding it may cause those globals to be ignored.
1958 * The LBFactoryMulti class is provided for this purpose, please see
1959 * includes/db/LBFactoryMulti.php for configuration information.
1961 $wgLBFactoryConf = [ 'class' => 'LBFactorySimple' ];
1964 * After a state-changing request is done by a client, this determines
1965 * how many seconds that client should keep using the master datacenter.
1966 * This avoids unexpected stale or 404 responses due to replication lag.
1969 $wgDataCenterUpdateStickTTL = 10;
1972 * File to log database errors to
1974 $wgDBerrorLog = false;
1977 * Timezone to use in the error log.
1978 * Defaults to the wiki timezone ($wgLocaltimezone).
1980 * A list of usable timezones can found at:
1981 * https://secure.php.net/manual/en/timezones.php
1985 * $wgDBerrorLogTZ = 'UTC';
1986 * $wgDBerrorLogTZ = 'GMT';
1987 * $wgDBerrorLogTZ = 'PST8PDT';
1988 * $wgDBerrorLogTZ = 'Europe/Sweden';
1989 * $wgDBerrorLogTZ = 'CET';
1994 $wgDBerrorLogTZ = false;
1997 * Set to true to engage MySQL 4.1/5.0 charset-related features;
1998 * for now will just cause sending of 'SET NAMES=utf8' on connect.
2000 * @warning THIS IS EXPERIMENTAL!
2002 * May break if you're not using the table defs from mysql5/tables.sql.
2003 * May break if you're upgrading an existing wiki if set differently.
2004 * Broken symptoms likely to include incorrect behavior with page titles,
2005 * usernames, comments etc containing non-ASCII characters.
2006 * Might also cause failures on the object cache and other things.
2008 * Even correct usage may cause failures with Unicode supplementary
2009 * characters (those not in the Basic Multilingual Plane) unless MySQL
2010 * has enhanced their Unicode support.
2012 $wgDBmysql5 = false;
2015 * Set true to enable Oracle DCRP (supported from 11gR1 onward)
2017 * To use this feature set to true and use a datasource defined as
2018 * POOLED (i.e. in tnsnames definition set server=pooled in connect_data
2021 * Starting from 11gR1 you can use DCRP (Database Resident Connection
2022 * Pool) that maintains established sessions and reuses them on new
2025 * Not completely tested, but it should fall back on normal connection
2026 * in case the pool is full or the datasource is not configured as
2028 * And the other way around; using oci_pconnect on a non pooled
2029 * datasource should produce a normal connection.
2031 * When it comes to frequent shortlived DB connections like with MW
2032 * Oracle tends to s***. The problem is the driver connects to the
2033 * database reasonably fast, but establishing a session takes time and
2034 * resources. MW does not rely on session state (as it does not use
2035 * features such as package variables) so establishing a valid session
2036 * is in this case an unwanted overhead that just slows things down.
2038 * @warning EXPERIMENTAL!
2040 $wgDBOracleDRCP = false;
2043 * Other wikis on this site, can be administered from a single developer
2045 * Array numeric key => database name
2047 $wgLocalDatabases = [];
2050 * If lag is higher than $wgSlaveLagWarning, show a warning in some special
2051 * pages (like watchlist). If the lag is higher than $wgSlaveLagCritical,
2052 * show a more obvious warning.
2054 $wgSlaveLagWarning = 10;
2057 * @see $wgSlaveLagWarning
2059 $wgSlaveLagCritical = 30;
2062 * Use Windows Authentication instead of $wgDBuser / $wgDBpassword for MS SQL Server
2064 $wgDBWindowsAuthentication = false;
2066 /**@}*/ # End of DB settings }
2068 /************************************************************************//**
2069 * @name Text storage
2074 * We can also compress text stored in the 'text' table. If this is set on, new
2075 * revisions will be compressed on page save if zlib support is available. Any
2076 * compressed revisions will be decompressed on load regardless of this setting,
2077 * but will not be readable at all* if zlib support is not available.
2079 $wgCompressRevisions = false;
2082 * External stores allow including content
2083 * from non database sources following URL links.
2085 * Short names of ExternalStore classes may be specified in an array here:
2087 * $wgExternalStores = [ "http","file","custom" ]...
2090 * CAUTION: Access to database might lead to code execution
2092 $wgExternalStores = [];
2095 * An array of external MySQL servers.
2098 * Create a cluster named 'cluster1' containing three servers:
2100 * $wgExternalServers = [
2101 * 'cluster1' => <array in the same format as $wgDBservers>
2105 * Used by LBFactorySimple, may be ignored if $wgLBFactoryConf is set to
2108 $wgExternalServers = [];
2111 * The place to put new revisions, false to put them in the local text table.
2112 * Part of a URL, e.g. DB://cluster1
2114 * Can be an array instead of a single string, to enable data distribution. Keys
2115 * must be consecutive integers, starting at zero.
2119 * $wgDefaultExternalStore = [ 'DB://cluster1', 'DB://cluster2' ];
2124 $wgDefaultExternalStore = false;
2127 * Revision text may be cached in $wgMemc to reduce load on external storage
2128 * servers and object extraction overhead for frequently-loaded revisions.
2130 * Set to 0 to disable, or number of seconds before cache expiry.
2132 $wgRevisionCacheExpiry = 86400 * 7;
2134 /** @} */ # end text storage }
2136 /************************************************************************//**
2137 * @name Performance hacks and limits
2142 * Disable database-intensive features
2144 $wgMiserMode = false;
2147 * Disable all query pages if miser mode is on, not just some
2149 $wgDisableQueryPages = false;
2152 * Number of rows to cache in 'querycache' table when miser mode is on
2154 $wgQueryCacheLimit = 1000;
2157 * Number of links to a page required before it is deemed "wanted"
2159 $wgWantedPagesThreshold = 1;
2162 * Enable slow parser functions
2164 $wgAllowSlowParserFunctions = false;
2167 * Allow schema updates
2169 $wgAllowSchemaUpdates = true;
2172 * Maximum article size in kilobytes
2174 $wgMaxArticleSize = 2048;
2177 * The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to
2178 * raise PHP's memory limit if it's below this amount.
2180 $wgMemoryLimit = "50M";
2183 * The minimum amount of time that MediaWiki needs for "slow" write request,
2184 * particularly ones with multiple non-atomic writes that *should* be as
2185 * transactional as possible; MediaWiki will call set_time_limit() if needed.
2188 $wgTransactionalTimeLimit = 120;
2190 /** @} */ # end performance hacks }
2192 /************************************************************************//**
2193 * @name Cache settings
2198 * Directory for caching data in the local filesystem. Should not be accessible
2201 * Note: if multiple wikis share the same localisation cache directory, they
2202 * must all have the same set of extensions. You can set a directory just for
2203 * the localisation cache using $wgLocalisationCacheConf['storeDirectory'].
2205 $wgCacheDirectory = false;
2208 * Main cache type. This should be a cache with fast access, but it may have
2209 * limited space. By default, it is disabled, since the stock database cache
2210 * is not fast enough to make it worthwhile.
2214 * - CACHE_ANYTHING: Use anything, as long as it works
2215 * - CACHE_NONE: Do not cache
2216 * - CACHE_DB: Store cache objects in the DB
2217 * - CACHE_MEMCACHED: MemCached, must specify servers in $wgMemCachedServers
2218 * - CACHE_ACCEL: APC, APCU, XCache or WinCache
2219 * - (other): A string may be used which identifies a cache
2220 * configuration in $wgObjectCaches.
2222 * @see $wgMessageCacheType, $wgParserCacheType
2224 $wgMainCacheType = CACHE_NONE
;
2227 * The cache type for storing the contents of the MediaWiki namespace. This
2228 * cache is used for a small amount of data which is expensive to regenerate.
2230 * For available types see $wgMainCacheType.
2232 $wgMessageCacheType = CACHE_ANYTHING
;
2235 * The cache type for storing article HTML. This is used to store data which
2236 * is expensive to regenerate, and benefits from having plenty of storage space.
2238 * For available types see $wgMainCacheType.
2240 $wgParserCacheType = CACHE_ANYTHING
;
2243 * The cache type for storing session data.
2245 * For available types see $wgMainCacheType.
2247 $wgSessionCacheType = CACHE_ANYTHING
;
2250 * The cache type for storing language conversion tables,
2251 * which are used when parsing certain text and interface messages.
2253 * For available types see $wgMainCacheType.
2257 $wgLanguageConverterCacheType = CACHE_ANYTHING
;
2260 * Advanced object cache configuration.
2262 * Use this to define the class names and constructor parameters which are used
2263 * for the various cache types. Custom cache types may be defined here and
2264 * referenced from $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType,
2265 * or $wgLanguageConverterCacheType.
2267 * The format is an associative array where the key is a cache identifier, and
2268 * the value is an associative array of parameters. The "class" parameter is the
2269 * class name which will be used. Alternatively, a "factory" parameter may be
2270 * given, giving a callable function which will generate a suitable cache object.
2273 CACHE_NONE
=> [ 'class' => 'EmptyBagOStuff', 'reportDupes' => false ],
2274 CACHE_DB
=> [ 'class' => 'SqlBagOStuff', 'loggroup' => 'SQLBagOStuff' ],
2276 CACHE_ANYTHING
=> [ 'factory' => 'ObjectCache::newAnything' ],
2277 CACHE_ACCEL
=> [ 'factory' => 'ObjectCache::getLocalServerInstance' ],
2278 CACHE_MEMCACHED
=> [ 'class' => 'MemcachedPhpBagOStuff', 'loggroup' => 'memcached' ],
2280 'db-replicated' => [
2281 'class' => 'ReplicatedBagOStuff',
2283 'class' => 'SqlBagOStuff',
2284 'args' => [ [ 'slaveOnly' => true ] ]
2287 'class' => 'SqlBagOStuff',
2288 'args' => [ [ 'slaveOnly' => false ] ]
2290 'loggroup' => 'SQLBagOStuff',
2291 'reportDupes' => false
2294 'apc' => [ 'class' => 'APCBagOStuff', 'reportDupes' => false ],
2295 'apcu' => [ 'class' => 'APCUBagOStuff', 'reportDupes' => false ],
2296 'xcache' => [ 'class' => 'XCacheBagOStuff', 'reportDupes' => false ],
2297 'wincache' => [ 'class' => 'WinCacheBagOStuff', 'reportDupes' => false ],
2298 'memcached-php' => [ 'class' => 'MemcachedPhpBagOStuff', 'loggroup' => 'memcached' ],
2299 'memcached-pecl' => [ 'class' => 'MemcachedPeclBagOStuff', 'loggroup' => 'memcached' ],
2300 'hash' => [ 'class' => 'HashBagOStuff', 'reportDupes' => false ],
2304 * Main Wide-Area-Network cache type. This should be a cache with fast access,
2305 * but it may have limited space. By default, it is disabled, since the basic stock
2306 * cache is not fast enough to make it worthwhile. For single data-center setups, this can
2307 * simply be pointed to a cache in $wgWANObjectCaches that uses a local $wgObjectCaches
2308 * cache with a relayer of type EventRelayerNull.
2311 * - false: Configure the cache using $wgMainCacheType, without using
2312 * a relayer (only matters if there are multiple data-centers)
2313 * - CACHE_NONE: Do not cache
2314 * - (other): A string may be used which identifies a cache
2315 * configuration in $wgWANObjectCaches
2318 $wgMainWANCache = false;
2321 * Advanced WAN object cache configuration.
2323 * Each WAN cache wraps a registered object cache (for the local cluster)
2324 * and it must also be configured to point to a PubSub instance. Subscribers
2325 * must be configured to relay purges to the actual cache servers.
2327 * The format is an associative array where the key is a cache identifier, and
2328 * the value is an associative array of parameters. The "cacheId" parameter is
2329 * a cache identifier from $wgObjectCaches. The "channels" parameter is a map of
2330 * actions ('purge') to PubSub channels defined in $wgEventRelayerConfig.
2331 * The "loggroup" parameter controls where log events are sent.
2335 $wgWANObjectCaches = [
2337 'class' => 'WANObjectCache',
2338 'cacheId' => CACHE_NONE
,
2341 /* Example of a simple single data-center cache:
2342 'memcached-php' => [
2343 'class' => 'WANObjectCache',
2344 'cacheId' => 'memcached-php',
2345 'channels' => [ 'purge' => 'wancache-main-memcached-purge' ]
2351 * Verify and enforce WAN cache purges using reliable DB sources as streams.
2353 * These secondary cache purges are de-duplicated via simple cache mutexes.
2354 * This improves consistency when cache purges are lost, which becomes more likely
2355 * as more cache servers are added or if there are multiple datacenters. Only keys
2356 * related to important mutable content will be checked.
2361 $wgEnableWANCacheReaper = false;
2364 * Main object stash type. This should be a fast storage system for storing
2365 * lightweight data like hit counters and user activity. Sites with multiple
2366 * data-centers should have this use a store that replicates all writes. The
2367 * store should have enough consistency for CAS operations to be usable.
2368 * Reads outside of those needed for merge() may be eventually consistent.
2371 * - db: Store cache objects in the DB
2372 * - (other): A string may be used which identifies a cache
2373 * configuration in $wgObjectCaches
2377 $wgMainStash = 'db-replicated';
2380 * The expiry time for the parser cache, in seconds.
2381 * The default is 86400 (one day).
2383 $wgParserCacheExpireTime = 86400;
2386 * @deprecated since 1.27, session data is always stored in object cache.
2388 $wgSessionsInObjectCache = true;
2391 * The expiry time to use for session storage, in seconds.
2393 $wgObjectCacheSessionExpiry = 3600;
2396 * @deprecated since 1.27, MediaWiki\Session\SessionManager doesn't use PHP session storage.
2398 $wgSessionHandler = null;
2401 * Whether to use PHP session handling ($_SESSION and session_*() functions)
2403 * If the constant MW_NO_SESSION is defined, this is forced to 'disable'.
2405 * If the constant MW_NO_SESSION_HANDLER is defined, this is ignored and PHP
2406 * session handling will function independently of SessionHandler.
2407 * SessionHandler and PHP's session handling may attempt to override each
2412 * - 'enable': Integrate with PHP's session handling as much as possible.
2413 * - 'warn': Integrate but log warnings if anything changes $_SESSION.
2414 * - 'disable': Throw exceptions if PHP session handling is used.
2416 $wgPHPSessionHandling = 'enable';
2419 * Number of internal PBKDF2 iterations to use when deriving session secrets.
2423 $wgSessionPbkdf2Iterations = 10001;
2426 * If enabled, will send MemCached debugging information to $wgDebugLogFile
2428 $wgMemCachedDebug = false;
2431 * The list of MemCached servers and port numbers
2433 $wgMemCachedServers = [ '127.0.0.1:11211' ];
2436 * Use persistent connections to MemCached, which are shared across multiple
2439 $wgMemCachedPersistent = false;
2442 * Read/write timeout for MemCached server communication, in microseconds.
2444 $wgMemCachedTimeout = 500000;
2447 * Set this to true to maintain a copy of the message cache on the local server.
2449 * This layer of message cache is in addition to the one configured by $wgMessageCacheType.
2451 * The local copy is put in APC. If APC is not installed, this setting does nothing.
2453 * Note that this is about the message cache, which stores interface messages
2454 * maintained as wiki pages. This is separate from the localisation cache for interface
2455 * messages provided by the software, which is configured by $wgLocalisationCacheConf.
2457 $wgUseLocalMessageCache = false;
2460 * Instead of caching everything, only cache those messages which have
2461 * been customised in the site content language. This means that
2462 * MediaWiki:Foo/ja is ignored if MediaWiki:Foo doesn't exist.
2463 * This option is probably only useful for translatewiki.net.
2465 $wgAdaptiveMessageCache = false;
2468 * Localisation cache configuration. Associative array with keys:
2469 * class: The class to use. May be overridden by extensions.
2471 * store: The location to store cache data. May be 'files', 'array', 'db' or
2472 * 'detect'. If set to "files", data will be in CDB files. If set
2473 * to "db", data will be stored to the database. If set to
2474 * "detect", files will be used if $wgCacheDirectory is set,
2475 * otherwise the database will be used.
2476 * "array" is an experimental option that uses PHP files that
2477 * store static arrays.
2479 * storeClass: The class name for the underlying storage. If set to a class
2480 * name, it overrides the "store" setting.
2482 * storeDirectory: If the store class puts its data in files, this is the
2483 * directory it will use. If this is false, $wgCacheDirectory
2486 * manualRecache: Set this to true to disable cache updates on web requests.
2487 * Use maintenance/rebuildLocalisationCache.php instead.
2489 $wgLocalisationCacheConf = [
2490 'class' => 'LocalisationCache',
2491 'store' => 'detect',
2492 'storeClass' => false,
2493 'storeDirectory' => false,
2494 'manualRecache' => false,
2498 * Allow client-side caching of pages
2500 $wgCachePages = true;
2503 * Set this to current time to invalidate all prior cached pages. Affects both
2504 * client-side and server-side caching.
2505 * You can get the current date on your server by using the command:
2507 * date +%Y%m%d%H%M%S
2510 $wgCacheEpoch = '20030516000000';
2513 * Directory where GitInfo will look for pre-computed cache files. If false,
2514 * $wgCacheDirectory/gitinfo will be used.
2516 $wgGitInfoCacheDirectory = false;
2519 * Bump this number when changing the global style sheets and JavaScript.
2521 * It should be appended in the query string of static CSS and JS includes,
2522 * to ensure that client-side caches do not keep obsolete copies of global
2525 $wgStyleVersion = '303';
2528 * This will cache static pages for non-logged-in users to reduce
2529 * database traffic on public sites. ResourceLoader requests to default
2530 * language and skins are cached as well as single module requests.
2532 $wgUseFileCache = false;
2535 * Depth of the subdirectory hierarchy to be created under
2536 * $wgFileCacheDirectory. The subdirectories will be named based on
2537 * the MD5 hash of the title. A value of 0 means all cache files will
2538 * be put directly into the main file cache directory.
2540 $wgFileCacheDepth = 2;
2543 * Kept for extension compatibility; see $wgParserCacheType
2544 * @deprecated since 1.26
2546 $wgEnableParserCache = true;
2549 * Append a configured value to the parser cache and the sitenotice key so
2550 * that they can be kept separate for some class of activity.
2552 $wgRenderHashAppend = '';
2555 * If on, the sidebar navigation links are cached for users with the
2556 * current language set. This can save a touch of load on a busy site
2557 * by shaving off extra message lookups.
2559 * However it is also fragile: changing the site configuration, or
2560 * having a variable $wgArticlePath, can produce broken links that
2561 * don't update as expected.
2563 $wgEnableSidebarCache = false;
2566 * Expiry time for the sidebar cache, in seconds
2568 $wgSidebarCacheExpiry = 86400;
2571 * When using the file cache, we can store the cached HTML gzipped to save disk
2572 * space. Pages will then also be served compressed to clients that support it.
2574 * Requires zlib support enabled in PHP.
2579 * Clock skew or the one-second resolution of time() can occasionally cause cache
2580 * problems when the user requests two pages within a short period of time. This
2581 * variable adds a given number of seconds to vulnerable timestamps, thereby giving
2584 $wgClockSkewFudge = 5;
2587 * Invalidate various caches when LocalSettings.php changes. This is equivalent
2588 * to setting $wgCacheEpoch to the modification time of LocalSettings.php, as
2589 * was previously done in the default LocalSettings.php file.
2591 * On high-traffic wikis, this should be set to false, to avoid the need to
2592 * check the file modification time, and to avoid the performance impact of
2593 * unnecessary cache invalidations.
2595 $wgInvalidateCacheOnLocalSettingsChange = true;
2598 * When loading extensions through the extension registration system, this
2599 * can be used to invalidate the cache. A good idea would be to set this to
2600 * one file, you can just `touch` that one to invalidate the cache
2604 * $wgExtensionInfoMtime = filemtime( "$IP/LocalSettings.php" );
2607 * If set to false, the mtime for each individual JSON file will be checked,
2608 * which can be slow if a large number of extensions are being loaded.
2612 $wgExtensionInfoMTime = false;
2614 /** @} */ # end of cache settings
2616 /************************************************************************//**
2617 * @name HTTP proxy (CDN) settings
2619 * Many of these settings apply to any HTTP proxy used in front of MediaWiki,
2620 * although they are referred to as Squid settings for historical reasons.
2622 * Achieving a high hit ratio with an HTTP proxy requires special
2623 * configuration. See https://www.mediawiki.org/wiki/Manual:Squid_caching for
2630 * Enable/disable CDN.
2631 * See https://www.mediawiki.org/wiki/Manual:Squid_caching
2633 $wgUseSquid = false;
2636 * If you run Squid3 with ESI support, enable this (default:false):
2641 * Send the Key HTTP header for better caching.
2642 * See https://datatracker.ietf.org/doc/draft-fielding-http-key/ for details.
2645 $wgUseKeyHeader = false;
2648 * Add X-Forwarded-Proto to the Vary and Key headers for API requests and
2649 * RSS/Atom feeds. Use this if you have an SSL termination setup
2650 * and need to split the cache between HTTP and HTTPS for API requests,
2651 * feed requests and HTTP redirect responses in order to prevent cache
2652 * pollution. This does not affect 'normal' requests to index.php other than
2655 $wgVaryOnXFP = false;
2658 * Internal server name as known to CDN, if different.
2662 * $wgInternalServer = 'http://yourinternal.tld:8000';
2665 $wgInternalServer = false;
2668 * Cache TTL for the CDN sent as s-maxage (without ESI) or
2669 * Surrogate-Control (with ESI). Without ESI, you should strip
2670 * out s-maxage in the CDN config.
2672 * 18000 seconds = 5 hours, more cache hits with 2678400 = 31 days.
2674 $wgSquidMaxage = 18000;
2677 * Cache timeout for the CDN when DB replica DB lag is high
2678 * @see $wgSquidMaxage
2681 $wgCdnMaxageLagged = 30;
2684 * If set, any SquidPurge call on a URL or URLs will send a second purge no less than
2685 * this many seconds later via the job queue. This requires delayed job support.
2686 * This should be safely higher than the 'max lag' value in $wgLBFactoryConf, so that
2687 * replica DB lag does not cause page to be stuck in stales states in CDN.
2689 * This also fixes race conditions in two-tiered CDN setups (e.g. cdn2 => cdn1 => MediaWiki).
2690 * If a purge for a URL reaches cdn2 before cdn1 and a request reaches cdn2 for that URL,
2691 * it will populate the response from the stale cdn1 value. When cdn1 gets the purge, cdn2
2692 * will still be stale. If the rebound purge delay is safely higher than the time to relay
2693 * a purge to all nodes, then the rebound puge will clear cdn2 after cdn1 was cleared.
2697 $wgCdnReboundPurgeDelay = 0;
2700 * Cache timeout for the CDN when a response is known to be wrong or incomplete (due to load)
2701 * @see $wgSquidMaxage
2704 $wgCdnMaxageSubstitute = 60;
2707 * Default maximum age for raw CSS/JS accesses
2709 * 300 seconds = 5 minutes.
2711 $wgForcedRawSMaxage = 300;
2714 * List of proxy servers to purge on changes; default port is 80. Use IP addresses.
2716 * When MediaWiki is running behind a proxy, it will trust X-Forwarded-For
2717 * headers sent/modified from these proxies when obtaining the remote IP address
2719 * For a list of trusted servers which *aren't* purged, see $wgSquidServersNoPurge.
2721 $wgSquidServers = [];
2724 * As above, except these servers aren't purged on page changes; use to set a
2725 * list of trusted proxies, etc. Supports both individual IP addresses and
2727 * @since 1.23 Supports CIDR ranges
2729 $wgSquidServersNoPurge = [];
2732 * Whether to use a Host header in purge requests sent to the proxy servers
2733 * configured in $wgSquidServers. Set this to false to support Squid
2734 * configured in forward-proxy mode.
2736 * If this is set to true, a Host header will be sent, and only the path
2737 * component of the URL will appear on the request line, as if the request
2738 * were a non-proxy HTTP 1.1 request. Varnish only supports this style of
2739 * request. Squid supports this style of request only if reverse-proxy mode
2740 * (http_port ... accel) is enabled.
2742 * If this is set to false, no Host header will be sent, and the absolute URL
2743 * will be sent in the request line, as is the standard for an HTTP proxy
2744 * request in both HTTP 1.0 and 1.1. This style of request is not supported
2745 * by Varnish, but is supported by Squid in either configuration (forward or
2750 $wgSquidPurgeUseHostHeader = true;
2753 * Routing configuration for HTCP multicast purging. Add elements here to
2754 * enable HTCP and determine which purges are sent where. If set to an empty
2755 * array, HTCP is disabled.
2757 * Each key in this array is a regular expression to match against the purged
2758 * URL, or an empty string to match all URLs. The purged URL is matched against
2759 * the regexes in the order specified, and the first rule whose regex matches
2760 * is used, all remaining rules will thus be ignored.
2762 * @par Example configuration to send purges for upload.wikimedia.org to one
2763 * multicast group and all other purges to another:
2765 * $wgHTCPRouting = [
2766 * '|^https?://upload\.wikimedia\.org|' => [
2767 * 'host' => '239.128.0.113',
2771 * 'host' => '239.128.0.112',
2777 * You can also pass an array of hosts to send purges too. This is useful when
2778 * you have several multicast groups or unicast address that should receive a
2779 * given purge. Multiple hosts support was introduced in MediaWiki 1.22.
2781 * @par Example of sending purges to multiple hosts:
2783 * $wgHTCPRouting = [
2785 * // Purges to text caches using multicast
2786 * [ 'host' => '239.128.0.114', 'port' => '4827' ],
2787 * // Purges to a hardcoded list of caches
2788 * [ 'host' => '10.88.66.1', 'port' => '4827' ],
2789 * [ 'host' => '10.88.66.2', 'port' => '4827' ],
2790 * [ 'host' => '10.88.66.3', 'port' => '4827' ],
2797 * $wgHTCPRouting replaces $wgHTCPMulticastRouting that was introduced in 1.20.
2798 * For back compatibility purposes, whenever its array is empty
2799 * $wgHTCPMutlicastRouting will be used as a fallback if it not null.
2801 * @see $wgHTCPMulticastTTL
2803 $wgHTCPRouting = [];
2806 * HTCP multicast TTL.
2807 * @see $wgHTCPRouting
2809 $wgHTCPMulticastTTL = 1;
2812 * Should forwarded Private IPs be accepted?
2814 $wgUsePrivateIPs = false;
2816 /** @} */ # end of HTTP proxy settings
2818 /************************************************************************//**
2819 * @name Language, regional and character encoding settings
2824 * Site language code. See languages/data/Names.php for languages supported by
2825 * MediaWiki out of the box. Not all languages listed there have translations,
2826 * see languages/messages/ for the list of languages with some localisation.
2828 * Warning: Don't use any of MediaWiki's deprecated language codes listed in
2829 * LanguageCode::getDeprecatedCodeMapping or $wgDummyLanguageCodes, like "no"
2830 * for Norwegian (use "nb" instead). If you do, things will break unexpectedly.
2832 * This defines the default interface language for all users, but users can
2833 * change it in their preferences.
2835 * This also defines the language of pages in the wiki. The content is wrapped
2836 * in a html element with lang=XX attribute. This behavior can be overridden
2837 * via hooks, see Title::getPageLanguage.
2839 $wgLanguageCode = 'en';
2842 * Language cache size, or really how many languages can we handle
2843 * simultaneously without degrading to crawl speed.
2845 $wgLangObjCacheSize = 10;
2848 * Some languages need different word forms, usually for different cases.
2849 * Used in Language::convertGrammar().
2853 * $wgGrammarForms['en']['genitive']['car'] = 'car\'s';
2856 $wgGrammarForms = [];
2859 * Treat language links as magic connectors, not inline links
2861 $wgInterwikiMagic = true;
2864 * Hide interlanguage links from the sidebar
2866 $wgHideInterlanguageLinks = false;
2869 * List of additional interwiki prefixes that should be treated as
2870 * interlanguage links (i.e. placed in the sidebar).
2872 * - This will not do anything unless the prefixes are defined in the interwiki
2874 * - The display text for these custom interlanguage links will be fetched from
2875 * the system message "interlanguage-link-xyz" where xyz is the prefix in
2877 * - A friendly name for each site, used for tooltip text, may optionally be
2878 * placed in the system message "interlanguage-link-sitename-xyz" where xyz is
2879 * the prefix in this array.
2881 $wgExtraInterlanguageLinkPrefixes = [];
2884 * List of language names or overrides for default names in Names.php
2886 $wgExtraLanguageNames = [];
2889 * List of mappings from one language code to another.
2890 * This array makes the codes not appear as a selectable language on the
2891 * installer, and excludes them when running the transstat.php script.
2893 * In Setup.php, the variable $wgDummyLanguageCodes is created by combining
2894 * these codes with a list of "deprecated" codes, which are mostly leftovers
2895 * from renames or other legacy things, and the internal codes 'qqq' and 'qqx'.
2896 * If a mapping in $wgExtraLanguageCodes collide with a built-in mapping, the
2897 * value in $wgExtraLanguageCodes will be used.
2901 $wgExtraLanguageCodes = [
2902 'bh' => 'bho', // Bihari language family
2903 'no' => 'nb', // Norwegian language family
2904 'simple' => 'en', // Simple English
2908 * Functionally the same as $wgExtraLanguageCodes, but deprecated. Instead of
2909 * appending values to this array, append them to $wgExtraLanguageCodes.
2911 * @deprecated since 1.29
2913 $wgDummyLanguageCodes = [];
2916 * Set this to true to replace Arabic presentation forms with their standard
2917 * forms in the U+0600-U+06FF block. This only works if $wgLanguageCode is
2920 * Note that pages with titles containing presentation forms will become
2921 * inaccessible, run maintenance/cleanupTitles.php to fix this.
2923 $wgFixArabicUnicode = true;
2926 * Set this to true to replace ZWJ-based chillu sequences in Malayalam text
2927 * with their Unicode 5.1 equivalents. This only works if $wgLanguageCode is
2928 * set to "ml". Note that some clients (even new clients as of 2010) do not
2929 * support these characters.
2931 * If you enable this on an existing wiki, run maintenance/cleanupTitles.php to
2932 * fix any ZWJ sequences in existing page titles.
2934 $wgFixMalayalamUnicode = true;
2937 * Set this to always convert certain Unicode sequences to modern ones
2938 * regardless of the content language. This has a small performance
2941 * See $wgFixArabicUnicode and $wgFixMalayalamUnicode for conversion
2946 $wgAllUnicodeFixes = false;
2949 * Set this to eg 'ISO-8859-1' to perform character set conversion when
2950 * loading old revisions not marked with "utf-8" flag. Use this when
2951 * converting a wiki from MediaWiki 1.4 or earlier to UTF-8 without the
2952 * burdensome mass conversion of old text data.
2954 * @note This DOES NOT touch any fields other than old_text. Titles, comments,
2955 * user names, etc still must be converted en masse in the database before
2956 * continuing as a UTF-8 wiki.
2958 $wgLegacyEncoding = false;
2961 * Browser Blacklist for unicode non compliant browsers. Contains a list of
2962 * regexps : "/regexp/" matching problematic browsers. These browsers will
2963 * be served encoded unicode in the edit box instead of real unicode.
2965 $wgBrowserBlackList = [
2967 * Netscape 2-4 detection
2968 * The minor version may contain strings such as "Gold" or "SGoldC-SGI"
2969 * Lots of non-netscape user agents have "compatible", so it's useful to check for that
2970 * with a negative assertion. The [UIN] identifier specifies the level of security
2971 * in a Netscape/Mozilla browser, checking for it rules out a number of fakers.
2972 * The language string is unreliable, it is missing on NS4 Mac.
2974 * Reference: http://www.psychedelix.com/agents/index.shtml
2976 '/^Mozilla\/2\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2977 '/^Mozilla\/3\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2978 '/^Mozilla\/4\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2981 * MSIE on Mac OS 9 is teh sux0r, converts þ to <thorn>, ð to <eth>,
2982 * Þ to <THORN> and Ð to <ETH>
2985 * - Mozilla/4.0 (compatible; MSIE 5.0; Mac_PowerPC)
2986 * - Mozilla/4.0 (compatible; MSIE 5.15; Mac_PowerPC)
2987 * - Mozilla/4.0 (compatible; MSIE 5.23; Mac_PowerPC)
2990 * @link https://en.wikipedia.org/w/index.php?diff=12356041&oldid=12355864
2991 * @link https://en.wikipedia.org/wiki/Template%3AOS9
2993 '/^Mozilla\/4\.0 \(compatible; MSIE \d+\.\d+; Mac_PowerPC\)/',
2996 * Google wireless transcoder, seems to eat a lot of chars alive
2997 * https://it.wikipedia.org/w/index.php?title=Luciano_Ligabue&diff=prev&oldid=8857361
2999 '/^Mozilla\/4\.0 \(compatible; MSIE 6.0; Windows NT 5.0; Google Wireless Transcoder;\)/'
3003 * If set to true, the MediaWiki 1.4 to 1.5 schema conversion will
3004 * create stub reference rows in the text table instead of copying
3005 * the full text of all current entries from 'cur' to 'text'.
3007 * This will speed up the conversion step for large sites, but
3008 * requires that the cur table be kept around for those revisions
3009 * to remain viewable.
3011 * This option affects the updaters *only*. Any present cur stub
3012 * revisions will be readable at runtime regardless of this setting.
3014 $wgLegacySchemaConversion = false;
3017 * Enable dates like 'May 12' instead of '12 May', if the default date format
3020 $wgAmericanDates = false;
3023 * For Hindi and Arabic use local numerals instead of Western style (0-9)
3024 * numerals in interface.
3026 $wgTranslateNumerals = true;
3029 * Translation using MediaWiki: namespace.
3030 * Interface messages will be loaded from the database.
3032 $wgUseDatabaseMessages = true;
3035 * Expiry time for the message cache key
3037 $wgMsgCacheExpiry = 86400;
3040 * Maximum entry size in the message cache, in bytes
3042 $wgMaxMsgCacheEntrySize = 10000;
3045 * Whether to enable language variant conversion.
3047 $wgDisableLangConversion = false;
3050 * Whether to enable language variant conversion for links.
3052 $wgDisableTitleConversion = false;
3055 * Default variant code, if false, the default will be the language code
3057 $wgDefaultLanguageVariant = false;
3060 * Disabled variants array of language variant conversion.
3064 * $wgDisabledVariants[] = 'zh-mo';
3065 * $wgDisabledVariants[] = 'zh-my';
3068 $wgDisabledVariants = [];
3071 * Like $wgArticlePath, but on multi-variant wikis, this provides a
3072 * path format that describes which parts of the URL contain the
3077 * $wgLanguageCode = 'sr';
3078 * $wgVariantArticlePath = '/$2/$1';
3079 * $wgArticlePath = '/wiki/$1';
3082 * A link to /wiki/ would be redirected to /sr/Главна_страна
3084 * It is important that $wgArticlePath not overlap with possible values
3085 * of $wgVariantArticlePath.
3087 $wgVariantArticlePath = false;
3090 * Show a bar of language selection links in the user login and user
3091 * registration forms; edit the "loginlanguagelinks" message to
3094 $wgLoginLanguageSelector = false;
3097 * When translating messages with wfMessage(), it is not always clear what
3098 * should be considered UI messages and what should be content messages.
3100 * For example, for the English Wikipedia, there should be only one 'mainpage',
3101 * so when getting the link for 'mainpage', we should treat it as site content
3102 * and call ->inContentLanguage()->text(), but for rendering the text of the
3103 * link, we call ->text(). The code behaves this way by default. However,
3104 * sites like the Wikimedia Commons do offer different versions of 'mainpage'
3105 * and the like for different languages. This array provides a way to override
3106 * the default behavior.
3109 * To allow language-specific main page and community
3112 * $wgForceUIMsgAsContentMsg = [ 'mainpage', 'portal-url' ];
3115 $wgForceUIMsgAsContentMsg = [];
3118 * Fake out the timezone that the server thinks it's in. This will be used for
3119 * date display and not for what's stored in the DB. Leave to null to retain
3120 * your server's OS-based timezone value.
3122 * This variable is currently used only for signature formatting and for local
3123 * time/date parser variables ({{LOCALTIME}} etc.)
3125 * Timezones can be translated by editing MediaWiki messages of type
3126 * timezone-nameinlowercase like timezone-utc.
3128 * A list of usable timezones can found at:
3129 * https://secure.php.net/manual/en/timezones.php
3133 * $wgLocaltimezone = 'UTC';
3134 * $wgLocaltimezone = 'GMT';
3135 * $wgLocaltimezone = 'PST8PDT';
3136 * $wgLocaltimezone = 'Europe/Sweden';
3137 * $wgLocaltimezone = 'CET';
3140 $wgLocaltimezone = null;
3143 * Set an offset from UTC in minutes to use for the default timezone setting
3144 * for anonymous users and new user accounts.
3146 * This setting is used for most date/time displays in the software, and is
3147 * overridable in user preferences. It is *not* used for signature timestamps.
3149 * By default, this will be set to match $wgLocaltimezone.
3151 $wgLocalTZoffset = null;
3153 /** @} */ # End of language/charset settings
3155 /*************************************************************************//**
3156 * @name Output format and skin settings
3161 * The default Content-Type header.
3163 $wgMimeType = 'text/html';
3166 * Previously used as content type in HTML script tags. This is now ignored since
3167 * HTML5 doesn't require a MIME type for script tags (javascript is the default).
3168 * It was also previously used by RawAction to determine the ctype query parameter
3169 * value that will result in a javascript response.
3170 * @deprecated since 1.22
3172 $wgJsMimeType = null;
3175 * The default xmlns attribute. The option to define this has been removed.
3176 * The value of this variable is no longer used by core and is set to a fixed
3177 * value in Setup.php for compatibility with extensions that depend on the value
3178 * of this variable being set. Such a dependency however is deprecated.
3179 * @deprecated since 1.22
3181 $wgXhtmlDefaultNamespace = null;
3184 * Previously used to determine if we should output an HTML5 doctype.
3185 * This is no longer used as we always output HTML5 now. For compatibility with
3186 * extensions that still check the value of this config it's value is now forced
3187 * to true by Setup.php.
3188 * @deprecated since 1.22
3193 * Defines the value of the version attribute in the <html> tag, if any.
3195 * If your wiki uses RDFa, set it to the correct value for RDFa+HTML5.
3196 * Correct current values are 'HTML+RDFa 1.0' or 'XHTML+RDFa 1.0'.
3197 * See also https://www.w3.org/TR/rdfa-in-html/#document-conformance
3200 $wgHtml5Version = null;
3203 * Temporary variable that allows HTMLForms to be rendered as tables.
3204 * Table based layouts cause various issues when designing for mobile.
3205 * This global allows skins or extensions a means to force non-table based rendering.
3206 * Setting to false forces form components to always render as div elements.
3209 $wgHTMLFormAllowTableFormat = true;
3212 * Temporary variable that applies MediaWiki UI wherever it can be supported.
3213 * Temporary variable that should be removed when mediawiki ui is more
3214 * stable and change has been communicated.
3217 $wgUseMediaWikiUIEverywhere = false;
3220 * Temporary variable that determines whether the EditPage class should use OOjs UI or not.
3221 * This will be removed later and OOjs UI will become the only option.
3225 $wgOOUIEditPage = true;
3228 * Whether to label the store-to-database-and-show-to-others button in the editor
3229 * as "Save page"/"Save changes" if false (the default) or, if true, instead as
3230 * "Publish page"/"Publish changes".
3234 $wgEditSubmitButtonLabelPublish = false;
3237 * Permit other namespaces in addition to the w3.org default.
3239 * Use the prefix for the key and the namespace for the value.
3243 * $wgXhtmlNamespaces['svg'] = 'http://www.w3.org/2000/svg';
3245 * Normally we wouldn't have to define this in the root "<html>"
3246 * element, but IE needs it there in some circumstances.
3248 * This is ignored if $wgMimeType is set to a non-XML MIME type.
3250 $wgXhtmlNamespaces = [];
3253 * Site notice shown at the top of each page
3255 * MediaWiki:Sitenotice page, which will override this. You can also
3256 * provide a separate message for logged-out users using the
3257 * MediaWiki:Anonnotice page.
3262 * If this is set, a "donate" link will appear in the sidebar. Set it to a URL.
3264 $wgSiteSupportPage = '';
3267 * Validate the overall output using tidy and refuse
3268 * to display the page if it's not valid.
3270 $wgValidateAllHtml = false;
3273 * Default skin, for new users and anonymous visitors. Registered users may
3274 * change this to any one of the other available skins in their preferences.
3276 $wgDefaultSkin = 'vector';
3279 * Fallback skin used when the skin defined by $wgDefaultSkin can't be found.
3283 $wgFallbackSkin = 'fallback';
3286 * Specify the names of skins that should not be presented in the list of
3287 * available skins in user preferences. If you want to remove a skin entirely,
3288 * remove it from the skins/ directory and its entry from LocalSettings.php.
3293 * @deprecated since 1.23; use $wgSkipSkins instead
3298 * Allow user Javascript page?
3299 * This enables a lot of neat customizations, but may
3300 * increase security risk to users and server load.
3302 $wgAllowUserJs = false;
3305 * Allow user Cascading Style Sheets (CSS)?
3306 * This enables a lot of neat customizations, but may
3307 * increase security risk to users and server load.
3309 $wgAllowUserCss = false;
3312 * Allow user-preferences implemented in CSS?
3313 * This allows users to customise the site appearance to a greater
3314 * degree; disabling it will improve page load times.
3316 $wgAllowUserCssPrefs = true;
3319 * Use the site's Javascript page?
3321 $wgUseSiteJs = true;
3324 * Use the site's Cascading Style Sheets (CSS)?
3326 $wgUseSiteCss = true;
3329 * Break out of framesets. This can be used to prevent clickjacking attacks,
3330 * or to prevent external sites from framing your site with ads.
3332 $wgBreakFrames = false;
3335 * The X-Frame-Options header to send on pages sensitive to clickjacking
3336 * attacks, such as edit pages. This prevents those pages from being displayed
3337 * in a frame or iframe. The options are:
3339 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3341 * - 'SAMEORIGIN': Allow framing by pages on the same domain. This can be used
3342 * to allow framing within a trusted domain. This is insecure if there
3343 * is a page on the same domain which allows framing of arbitrary URLs.
3345 * - false: Allow all framing. This opens up the wiki to XSS attacks and thus
3346 * full compromise of local user accounts. Private wikis behind a
3347 * corporate firewall are especially vulnerable. This is not
3350 * For extra safety, set $wgBreakFrames = true, to prevent framing on all pages,
3351 * not just edit pages.
3353 $wgEditPageFrameOptions = 'DENY';
3356 * Disallow framing of API pages directly, by setting the X-Frame-Options
3357 * header. Since the API returns CSRF tokens, allowing the results to be
3358 * framed can compromise your user's account security.
3360 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3361 * - 'SAMEORIGIN': Allow framing by pages on the same domain.
3362 * - false: Allow all framing.
3363 * Note: $wgBreakFrames will override this for human formatted API output.
3365 $wgApiFrameOptions = 'DENY';
3368 * Disable output compression (enabled by default if zlib is available)
3370 $wgDisableOutputCompression = false;
3373 * Should we allow a broader set of characters in id attributes, per HTML5? If
3374 * not, use only HTML 4-compatible IDs. This option is for testing -- when the
3375 * functionality is ready, it will be on by default with no option.
3377 * Currently this appears to work fine in all browsers, but it's disabled by
3378 * default because it normalizes id's a bit too aggressively, breaking preexisting
3379 * content (particularly Cite). See T29733, T29694, T29474.
3381 $wgExperimentalHtmlIds = false;
3384 * Abstract list of footer icons for skins in place of old copyrightico and poweredbyico code
3385 * You can add new icons to the built in copyright or poweredby, or you can create
3386 * a new block. Though note that you may need to add some custom css to get good styling
3387 * of new blocks in monobook. vector and modern should work without any special css.
3389 * $wgFooterIcons itself is a key/value array.
3390 * The key is the name of a block that the icons will be wrapped in. The final id varies
3391 * by skin; Monobook and Vector will turn poweredby into f-poweredbyico while Modern
3392 * turns it into mw_poweredby.
3393 * The value is either key/value array of icons or a string.
3394 * In the key/value array the key may or may not be used by the skin but it can
3395 * be used to find the icon and unset it or change the icon if needed.
3396 * This is useful for disabling icons that are set by extensions.
3397 * The value should be either a string or an array. If it is a string it will be output
3398 * directly as html, however some skins may choose to ignore it. An array is the preferred format
3399 * for the icon, the following keys are used:
3400 * - src: An absolute url to the image to use for the icon, this is recommended
3401 * but not required, however some skins will ignore icons without an image
3402 * - srcset: optional additional-resolution images; see HTML5 specs
3403 * - url: The url to use in the a element around the text or icon, if not set an a element will
3405 * - alt: This is the text form of the icon, it will be displayed without an image in
3406 * skins like Modern or if src is not set, and will otherwise be used as
3407 * the alt="" for the image. This key is required.
3408 * - width and height: If the icon specified by src is not of the standard size
3409 * you can specify the size of image to use with these keys.
3410 * Otherwise they will default to the standard 88x31.
3411 * @todo Reformat documentation.
3415 "copyright" => [], // placeholder for the built in copyright icon
3419 // Defaults to point at
3420 // "$wgResourceBasePath/resources/assets/poweredby_mediawiki_88x31.png"
3421 // plus srcset for 1.5x, 2x resolution variants.
3423 "url" => "//www.mediawiki.org/",
3424 "alt" => "Powered by MediaWiki",
3430 * Login / create account link behavior when it's possible for anonymous users
3431 * to create an account.
3432 * - true = use a combined login / create account link
3433 * - false = split login and create account into two separate links
3435 $wgUseCombinedLoginLink = false;
3438 * Display user edit counts in various prominent places.
3440 $wgEdititis = false;
3443 * Some web hosts attempt to rewrite all responses with a 404 (not found)
3444 * status code, mangling or hiding MediaWiki's output. If you are using such a
3445 * host, you should start looking for a better one. While you're doing that,
3446 * set this to false to convert some of MediaWiki's 404 responses to 200 so
3447 * that the generated error pages can be seen.
3449 * In cases where for technical reasons it is more important for MediaWiki to
3450 * send the correct status code than for the body to be transmitted intact,
3451 * this configuration variable is ignored.
3453 $wgSend404Code = true;
3456 * The $wgShowRollbackEditCount variable is used to show how many edits can be rolled back.
3457 * The numeric value of the variable controls how many edits MediaWiki will look back to
3458 * determine whether a rollback is allowed (by checking that they are all from the same author).
3459 * If the value is false or 0, the edits are not counted. Disabling this will prevent MediaWiki
3460 * from hiding some useless rollback links.
3464 $wgShowRollbackEditCount = 10;
3467 * Output a <link rel="canonical"> tag on every page indicating the canonical
3468 * server which should be used, i.e. $wgServer or $wgCanonicalServer. Since
3469 * detection of the current server is unreliable, the link is sent
3472 $wgEnableCanonicalServerLink = false;
3475 * When OutputHandler is used, mangle any output that contains
3476 * <cross-domain-policy>. Without this, an attacker can send their own
3477 * cross-domain policy unless it is prevented by the crossdomain.xml file at
3482 $wgMangleFlashPolicy = true;
3484 /** @} */ # End of output format settings }
3486 /*************************************************************************//**
3487 * @name ResourceLoader settings
3492 * Client-side resource modules.
3494 * Extensions should add their ResourceLoader module definitions
3495 * to the $wgResourceModules variable.
3499 * $wgResourceModules['ext.myExtension'] = [
3500 * 'scripts' => 'myExtension.js',
3501 * 'styles' => 'myExtension.css',
3502 * 'dependencies' => [ 'jquery.cookie', 'jquery.tabIndex' ],
3503 * 'localBasePath' => __DIR__,
3504 * 'remoteExtPath' => 'MyExtension',
3508 $wgResourceModules = [];
3511 * Skin-specific styles for resource modules.
3513 * These are later added to the 'skinStyles' list of the existing module. The 'styles' list can
3514 * not be modified or disabled.
3516 * For example, here is a module "bar" and how skin Foo would provide additional styles for it.
3520 * $wgResourceModules['bar'] = [
3521 * 'scripts' => 'resources/bar/bar.js',
3522 * 'styles' => 'resources/bar/main.css',
3525 * $wgResourceModuleSkinStyles['foo'] = [
3526 * 'bar' => 'skins/Foo/bar.css',
3530 * This is mostly equivalent to:
3534 * $wgResourceModules['bar'] = [
3535 * 'scripts' => 'resources/bar/bar.js',
3536 * 'styles' => 'resources/bar/main.css',
3538 * 'foo' => skins/Foo/bar.css',
3543 * If the module already defines its own entry in `skinStyles` for a given skin, then
3544 * $wgResourceModuleSkinStyles is ignored.
3546 * If a module defines a `skinStyles['default']` the skin may want to extend that instead
3547 * of replacing them. This can be done using the `+` prefix.
3551 * $wgResourceModules['bar'] = [
3552 * 'scripts' => 'resources/bar/bar.js',
3553 * 'styles' => 'resources/bar/basic.css',
3555 * 'default' => 'resources/bar/additional.css',
3558 * // Note the '+' character:
3559 * $wgResourceModuleSkinStyles['foo'] = [
3560 * '+bar' => 'skins/Foo/bar.css',
3564 * This is mostly equivalent to:
3568 * $wgResourceModules['bar'] = [
3569 * 'scripts' => 'resources/bar/bar.js',
3570 * 'styles' => 'resources/bar/basic.css',
3572 * 'default' => 'resources/bar/additional.css',
3574 * 'resources/bar/additional.css',
3575 * 'skins/Foo/bar.css',
3581 * In other words, as a module author, use the `styles` list for stylesheets that may not be
3582 * disabled by a skin. To provide default styles that may be extended or replaced,
3583 * use `skinStyles['default']`.
3585 * As with $wgResourceModules, paths default to being relative to the MediaWiki root.
3586 * You should always provide a localBasePath and remoteBasePath (or remoteExtPath/remoteSkinPath).
3590 * $wgResourceModuleSkinStyles['foo'] = [
3591 * 'bar' => 'bar.css',
3592 * 'quux' => 'quux.css',
3593 * 'remoteSkinPath' => 'Foo',
3594 * 'localBasePath' => __DIR__,
3598 $wgResourceModuleSkinStyles = [];
3601 * Extensions should register foreign module sources here. 'local' is a
3602 * built-in source that is not in this array, but defined by
3603 * ResourceLoader::__construct() so that it cannot be unset.
3607 * $wgResourceLoaderSources['foo'] = 'http://example.org/w/load.php';
3610 $wgResourceLoaderSources = [];
3613 * The default 'remoteBasePath' value for instances of ResourceLoaderFileModule.
3614 * Defaults to $wgScriptPath.
3616 $wgResourceBasePath = null;
3619 * Maximum time in seconds to cache resources served by ResourceLoader.
3620 * Used to set last modified headers (max-age/s-maxage).
3622 * Following options to distinguish:
3623 * - versioned: Used for modules with a version, because changing version
3624 * numbers causes cache misses. This normally has a long expiry time.
3625 * - unversioned: Used for modules without a version to propagate changes
3626 * quickly to clients. Also used for modules with errors to recover quickly.
3627 * This normally has a short expiry time.
3629 * Expiry time for the options to distinguish:
3630 * - server: Squid/Varnish but also any other public proxy cache between the
3631 * client and MediaWiki.
3632 * - client: On the client side (e.g. in the browser cache).
3634 $wgResourceLoaderMaxage = [
3636 'server' => 30 * 24 * 60 * 60, // 30 days
3637 'client' => 30 * 24 * 60 * 60, // 30 days
3640 'server' => 5 * 60, // 5 minutes
3641 'client' => 5 * 60, // 5 minutes
3646 * The default debug mode (on/off) for of ResourceLoader requests.
3648 * This will still be overridden when the debug URL parameter is used.
3650 $wgResourceLoaderDebug = false;
3653 * Put each statement on its own line when minifying JavaScript. This makes
3654 * debugging in non-debug mode a bit easier.
3656 * @deprecated since 1.27: Always false; no longer configurable.
3658 $wgResourceLoaderMinifierStatementsOnOwnLine = false;
3661 * Maximum line length when minifying JavaScript. This is not a hard maximum:
3662 * the minifier will try not to produce lines longer than this, but may be
3663 * forced to do so in certain cases.
3665 * @deprecated since 1.27: Always 1,000; no longer configurable.
3667 $wgResourceLoaderMinifierMaxLineLength = 1000;
3670 * Whether to ensure the mediawiki.legacy library is loaded before other modules.
3672 * @deprecated since 1.26: Always declare dependencies.
3674 $wgIncludeLegacyJavaScript = false;
3677 * Use jQuery 3 (with jQuery Migrate) instead of jQuery 1.
3679 * This is a temporary feature flag for the MediaWiki 1.29 development cycle while
3680 * instabilities with jQuery 3 are being addressed. See T124742.
3682 * @deprecated since 1.29
3684 $wgUsejQueryThree = true;
3687 * Whether or not to assign configuration variables to the global window object.
3689 * If this is set to false, old code using deprecated variables will no longer
3692 * @par Example of legacy code:
3694 * if ( window.wgRestrictionEdit ) { ... }
3698 * if ( wgIsArticle ) { ... }
3701 * Instead, one needs to use mw.config.
3702 * @par Example using mw.config global configuration:
3704 * if ( mw.config.exists('wgRestrictionEdit') ) { ... }
3708 * if ( mw.config.get('wgIsArticle') ) { ... }
3711 $wgLegacyJavaScriptGlobals = true;
3714 * If set to a positive number, ResourceLoader will not generate URLs whose
3715 * query string is more than this many characters long, and will instead use
3716 * multiple requests with shorter query strings. This degrades performance,
3717 * but may be needed if your web server has a low (less than, say 1024)
3718 * query string length limit or a low value for suhosin.get.max_value_length
3719 * that you can't increase.
3721 * If set to a negative number, ResourceLoader will assume there is no query
3722 * string length limit.
3724 * Defaults to a value based on php configuration.
3726 $wgResourceLoaderMaxQueryLength = false;
3729 * If set to true, JavaScript modules loaded from wiki pages will be parsed
3730 * prior to minification to validate it.
3732 * Parse errors will result in a JS exception being thrown during module load,
3733 * which avoids breaking other modules loaded in the same request.
3735 $wgResourceLoaderValidateJS = true;
3738 * If set to true, statically-sourced (file-backed) JavaScript resources will
3739 * be parsed for validity before being bundled up into ResourceLoader modules.
3741 * This can be helpful for development by providing better error messages in
3742 * default (non-debug) mode, but JavaScript parsing is slow and memory hungry
3743 * and may fail on large pre-bundled frameworks.
3745 $wgResourceLoaderValidateStaticJS = false;
3748 * Global LESS variables. An associative array binding variable names to
3749 * LESS code snippets representing their values.
3751 * Adding an item here is equivalent to writing `@variable: value;`
3752 * at the beginning of all your .less files, with all the consequences.
3753 * In particular, string values must be escaped and quoted.
3755 * Changes to LESS variables do not trigger cache invalidation.
3757 * If the LESS variables need to be dynamic, you can use the
3758 * ResourceLoaderGetLessVars hook (since 1.25).
3762 * $wgResourceLoaderLESSVars = [
3763 * 'baseFontSize' => '1em',
3764 * 'smallFontSize' => '0.75em',
3765 * 'WikimediaBlue' => '#006699',
3770 $wgResourceLoaderLESSVars = [
3772 * Minimum available screen width at which a device can be considered a tablet/desktop
3773 * The number is currently based on the device width of a Samsung Galaxy S5 mini and is low
3774 * enough to cover iPad (768px). Number is prone to change with new information.
3777 'deviceWidthTablet' => '720px',
3781 * Default import paths for LESS modules. LESS files referenced in @import
3782 * statements will be looked up here first, and relative to the importing file
3783 * second. To avoid collisions, it's important for the LESS files in these
3784 * directories to have a common, predictable file name prefix.
3786 * Extensions need not (and should not) register paths in
3787 * $wgResourceLoaderLESSImportPaths. The import path includes the path of the
3788 * currently compiling LESS file, which allows each extension to freely import
3789 * files from its own tree.
3793 $wgResourceLoaderLESSImportPaths = [
3794 "$IP/resources/src/mediawiki.less/",
3798 * Whether ResourceLoader should attempt to persist modules in localStorage on
3799 * browsers that support the Web Storage API.
3801 $wgResourceLoaderStorageEnabled = true;
3804 * Cache version for client-side ResourceLoader module storage. You can trigger
3805 * invalidation of the contents of the module store by incrementing this value.
3809 $wgResourceLoaderStorageVersion = 1;
3812 * Whether to allow site-wide CSS (MediaWiki:Common.css and friends) on
3813 * restricted pages like Special:UserLogin or Special:Preferences where
3814 * JavaScript is disabled for security reasons. As it is possible to
3815 * execute JavaScript through CSS, setting this to true opens up a
3816 * potential security hole. Some sites may "skin" their wiki by using
3817 * site-wide CSS, causing restricted pages to look unstyled and different
3818 * from the rest of the site.
3822 $wgAllowSiteCSSOnRestrictedPages = false;
3824 /** @} */ # End of ResourceLoader settings }
3826 /*************************************************************************//**
3827 * @name Page title and interwiki link settings
3832 * Name of the project namespace. If left set to false, $wgSitename will be
3835 $wgMetaNamespace = false;
3838 * Name of the project talk namespace.
3840 * Normally you can ignore this and it will be something like
3841 * $wgMetaNamespace . "_talk". In some languages, you may want to set this
3842 * manually for grammatical reasons.
3844 $wgMetaNamespaceTalk = false;
3847 * Additional namespaces. If the namespaces defined in Language.php and
3848 * Namespace.php are insufficient, you can create new ones here, for example,
3849 * to import Help files in other languages. You can also override the namespace
3850 * names of existing namespaces. Extensions should use the CanonicalNamespaces
3851 * hook or extension.json.
3853 * @warning Once you delete a namespace, the pages in that namespace will
3854 * no longer be accessible. If you rename it, then you can access them through
3855 * the new namespace name.
3857 * Custom namespaces should start at 100 to avoid conflicting with standard
3858 * namespaces, and should always follow the even/odd main/talk pattern.
3862 * $wgExtraNamespaces = [
3864 * 101 => "Hilfe_Diskussion",
3866 * 103 => "Discussion_Aide"
3870 * @todo Add a note about maintenance/namespaceDupes.php
3872 $wgExtraNamespaces = [];
3875 * Same as above, but for namespaces with gender distinction.
3876 * Note: the default form for the namespace should also be set
3877 * using $wgExtraNamespaces for the same index.
3880 $wgExtraGenderNamespaces = [];
3883 * Namespace aliases.
3885 * These are alternate names for the primary localised namespace names, which
3886 * are defined by $wgExtraNamespaces and the language file. If a page is
3887 * requested with such a prefix, the request will be redirected to the primary
3890 * Set this to a map from namespace names to IDs.
3894 * $wgNamespaceAliases = [
3895 * 'Wikipedian' => NS_USER,
3900 $wgNamespaceAliases = [];
3903 * Allowed title characters -- regex character class
3904 * Don't change this unless you know what you're doing
3906 * Problematic punctuation:
3907 * - []{}|# Are needed for link syntax, never enable these
3908 * - <> Causes problems with HTML escaping, don't use
3909 * - % Enabled by default, minor problems with path to query rewrite rules, see below
3910 * - + Enabled by default, but doesn't work with path to query rewrite rules,
3911 * corrupted by apache
3912 * - ? Enabled by default, but doesn't work with path to PATH_INFO rewrites
3914 * All three of these punctuation problems can be avoided by using an alias,
3915 * instead of a rewrite rule of either variety.
3917 * The problem with % is that when using a path to query rewrite rule, URLs are
3918 * double-unescaped: once by Apache's path conversion code, and again by PHP. So
3919 * %253F, for example, becomes "?". Our code does not double-escape to compensate
3920 * for this, indeed double escaping would break if the double-escaped title was
3921 * passed in the query string rather than the path. This is a minor security issue
3922 * because articles can be created such that they are hard to view or edit.
3924 * In some rare cases you may wish to remove + for compatibility with old links.
3926 * Theoretically 0x80-0x9F of ISO 8859-1 should be disallowed, but
3927 * this breaks interlanguage links
3929 $wgLegalTitleChars = " %!\"$&'()*,\\-.\\/0-9:;=?@A-Z\\\\^_`a-z~\\x80-\\xFF+";
3932 * The interwiki prefix of the current wiki, or false if it doesn't have one.
3934 * @deprecated since 1.23; use $wgLocalInterwikis instead
3936 $wgLocalInterwiki = false;
3939 * Array for multiple $wgLocalInterwiki values, in case there are several
3940 * interwiki prefixes that point to the current wiki. If $wgLocalInterwiki is
3941 * set, its value is prepended to this array, for backwards compatibility.
3943 * Note, recent changes feeds use only the first entry in this array (or
3944 * $wgLocalInterwiki, if it is set). See $wgRCFeeds
3946 $wgLocalInterwikis = [];
3949 * Expiry time for cache of interwiki table
3951 $wgInterwikiExpiry = 10800;
3954 * @name Interwiki caching settings.
3959 * Interwiki cache, either as an associative array or a path to a constant
3960 * database (.cdb) file.
3962 * This data structure database is generated by the `dumpInterwiki` maintenance
3963 * script (which lives in the WikimediaMaintenance repository) and has key
3964 * formats such as the following:
3966 * - dbname:key - a simple key (e.g. enwiki:meta)
3967 * - _sitename:key - site-scope key (e.g. wiktionary:meta)
3968 * - __global:key - global-scope key (e.g. __global:meta)
3969 * - __sites:dbname - site mapping (e.g. __sites:enwiki)
3971 * Sites mapping just specifies site name, other keys provide "local url"
3974 * @var bool|array|string
3976 $wgInterwikiCache = false;
3979 * Specify number of domains to check for messages.
3980 * - 1: Just wiki(db)-level
3981 * - 2: wiki and global levels
3984 $wgInterwikiScopes = 3;
3987 * Fallback site, if unable to resolve from cache
3989 $wgInterwikiFallbackSite = 'wiki';
3991 /** @} */ # end of Interwiki caching settings.
3994 * @name SiteStore caching settings.
3999 * Specify the file location for the Sites json cache file.
4001 $wgSitesCacheFile = false;
4003 /** @} */ # end of SiteStore caching settings.
4006 * If local interwikis are set up which allow redirects,
4007 * set this regexp to restrict URLs which will be displayed
4008 * as 'redirected from' links.
4011 * It might look something like this:
4013 * $wgRedirectSources = '!^https?://[a-z-]+\.wikipedia\.org/!';
4016 * Leave at false to avoid displaying any incoming redirect markers.
4017 * This does not affect intra-wiki redirects, which don't change
4020 $wgRedirectSources = false;
4023 * Set this to false to avoid forcing the first letter of links to capitals.
4025 * @warning may break links! This makes links COMPLETELY case-sensitive. Links
4026 * appearing with a capital at the beginning of a sentence will *not* go to the
4027 * same place as links in the middle of a sentence using a lowercase initial.
4029 $wgCapitalLinks = true;
4032 * @since 1.16 - This can now be set per-namespace. Some special namespaces (such
4033 * as Special, see MWNamespace::$alwaysCapitalizedNamespaces for the full list) must be
4034 * true by default (and setting them has no effect), due to various things that
4035 * require them to be so. Also, since Talk namespaces need to directly mirror their
4036 * associated content namespaces, the values for those are ignored in favor of the
4037 * subject namespace's setting. Setting for NS_MEDIA is taken automatically from
4042 * $wgCapitalLinkOverrides[ NS_FILE ] = false;
4045 $wgCapitalLinkOverrides = [];
4048 * Which namespaces should support subpages?
4049 * See Language.php for a list of namespaces.
4051 $wgNamespacesWithSubpages = [
4054 NS_USER_TALK
=> true,
4056 NS_PROJECT_TALK
=> true,
4057 NS_FILE_TALK
=> true,
4058 NS_MEDIAWIKI
=> true,
4059 NS_MEDIAWIKI_TALK
=> true,
4060 NS_TEMPLATE
=> true,
4061 NS_TEMPLATE_TALK
=> true,
4063 NS_HELP_TALK
=> true,
4064 NS_CATEGORY_TALK
=> true
4068 * Array holding default tracking category names.
4070 * Array contains the system messages for each tracking category.
4071 * Tracking categories allow pages with certain characteristics to be tracked.
4072 * It works by adding any such page to a category automatically.
4074 * A message with the suffix '-desc' should be added as a description message
4075 * to have extra information on Special:TrackingCategories.
4077 * @deprecated since 1.25 Extensions should now register tracking categories using
4078 * the new extension registration system.
4082 $wgTrackingCategories = [];
4085 * Array of namespaces which can be deemed to contain valid "content", as far
4086 * as the site statistics are concerned. Useful if additional namespaces also
4087 * contain "content" which should be considered when generating a count of the
4088 * number of articles in the wiki.
4090 $wgContentNamespaces = [ NS_MAIN
];
4093 * Array of namespaces, in addition to the talk namespaces, where signatures
4094 * (~~~~) are likely to be used. This determines whether to display the
4095 * Signature button on the edit toolbar, and may also be used by extensions.
4096 * For example, "traditional" style wikis, where content and discussion are
4097 * intermixed, could place NS_MAIN and NS_PROJECT namespaces in this array.
4099 $wgExtraSignatureNamespaces = [];
4102 * Max number of redirects to follow when resolving redirects.
4103 * 1 means only the first redirect is followed (default behavior).
4104 * 0 or less means no redirects are followed.
4106 $wgMaxRedirects = 1;
4109 * Array of invalid page redirect targets.
4110 * Attempting to create a redirect to any of the pages in this array
4111 * will make the redirect fail.
4112 * Userlogout is hard-coded, so it does not need to be listed here.
4113 * (T12569) Disallow Mypage and Mytalk as well.
4115 * As of now, this only checks special pages. Redirects to pages in
4116 * other namespaces cannot be invalidated by this variable.
4118 $wgInvalidRedirectTargets = [ 'Filepath', 'Mypage', 'Mytalk', 'Redirect' ];
4120 /** @} */ # End of title and interwiki settings }
4122 /************************************************************************//**
4123 * @name Parser settings
4124 * These settings configure the transformation from wikitext to HTML.
4129 * Parser configuration. Associative array with the following members:
4131 * class The class name
4133 * preprocessorClass The preprocessor class. Two classes are currently available:
4134 * Preprocessor_Hash, which uses plain PHP arrays for temporary
4135 * storage, and Preprocessor_DOM, which uses the DOM module for
4136 * temporary storage. Preprocessor_DOM generally uses less memory;
4137 * the speed of the two is roughly the same.
4139 * If this parameter is not given, it uses Preprocessor_DOM if the
4140 * DOM module is available, otherwise it uses Preprocessor_Hash.
4142 * The entire associative array will be passed through to the constructor as
4143 * the first parameter. Note that only Setup.php can use this variable --
4144 * the configuration will change at runtime via $wgParser member functions, so
4145 * the contents of this variable will be out-of-date. The variable can only be
4146 * changed during LocalSettings.php, in particular, it can't be changed during
4147 * an extension setup function.
4150 'class' => 'Parser',
4151 # 'preprocessorClass' => 'Preprocessor_Hash',
4155 * Maximum indent level of toc.
4157 $wgMaxTocLevel = 999;
4160 * A complexity limit on template expansion: the maximum number of nodes visited
4161 * by PPFrame::expand()
4163 $wgMaxPPNodeCount = 1000000;
4166 * A complexity limit on template expansion: the maximum number of elements
4167 * generated by Preprocessor::preprocessToObj(). This allows you to limit the
4168 * amount of memory used by the Preprocessor_DOM node cache: testing indicates
4169 * that each element uses about 160 bytes of memory on a 64-bit processor, so
4170 * this default corresponds to about 155 MB.
4172 * When the limit is exceeded, an exception is thrown.
4174 $wgMaxGeneratedPPNodeCount = 1000000;
4177 * Maximum recursion depth for templates within templates.
4178 * The current parser adds two levels to the PHP call stack for each template,
4179 * and xdebug limits the call stack to 100 by default. So this should hopefully
4180 * stop the parser before it hits the xdebug limit.
4182 $wgMaxTemplateDepth = 40;
4185 * @see $wgMaxTemplateDepth
4187 $wgMaxPPExpandDepth = 40;
4190 * URL schemes that should be recognized as valid by wfParseUrl().
4192 * WARNING: Do not add 'file:' to this or internal file links will be broken.
4193 * Instead, if you want to support file links, add 'file://'. The same applies
4194 * to any other protocols with the same name as a namespace. See task T46011 for
4200 'bitcoin:', 'ftp://', 'ftps://', 'geo:', 'git://', 'gopher://', 'http://',
4201 'https://', 'irc://', 'ircs://', 'magnet:', 'mailto:', 'mms://', 'news:',
4202 'nntp://', 'redis://', 'sftp://', 'sip:', 'sips:', 'sms:', 'ssh://',
4203 'svn://', 'tel:', 'telnet://', 'urn:', 'worldwind://', 'xmpp:', '//'
4207 * If true, removes (by substituting) templates in signatures.
4209 $wgCleanSignatures = true;
4212 * Whether to allow inline image pointing to other websites
4214 $wgAllowExternalImages = false;
4217 * If the above is false, you can specify an exception here. Image URLs
4218 * that start with this string are then rendered, while all others are not.
4219 * You can use this to set up a trusted, simple repository of images.
4220 * You may also specify an array of strings to allow multiple sites
4224 * $wgAllowExternalImagesFrom = 'http://127.0.0.1/';
4225 * $wgAllowExternalImagesFrom = [ 'http://127.0.0.1/', 'http://example.com' ];
4228 $wgAllowExternalImagesFrom = '';
4231 * If $wgAllowExternalImages is false, you can allow an on-wiki
4232 * whitelist of regular expression fragments to match the image URL
4233 * against. If the image matches one of the regular expression fragments,
4234 * The image will be displayed.
4236 * Set this to true to enable the on-wiki whitelist (MediaWiki:External image whitelist)
4237 * Or false to disable it
4239 $wgEnableImageWhitelist = true;
4242 * A different approach to the above: simply allow the "<img>" tag to be used.
4243 * This allows you to specify alt text and other attributes, copy-paste HTML to
4244 * your wiki more easily, etc. However, allowing external images in any manner
4245 * will allow anyone with editing rights to snoop on your visitors' IP
4246 * addresses and so forth, if they wanted to, by inserting links to images on
4247 * sites they control.
4249 $wgAllowImageTag = false;
4252 * Configuration for HTML postprocessing tool. Set this to a configuration
4253 * array to enable an external tool. Dave Raggett's "HTML Tidy" is typically
4254 * used. See https://www.w3.org/People/Raggett/tidy/
4256 * If this is null and $wgUseTidy is true, the deprecated configuration
4257 * parameters will be used instead.
4259 * If this is null and $wgUseTidy is false, a pure PHP fallback will be used.
4263 * - RaggettInternalHHVM: Use the limited-functionality HHVM extension
4264 * - RaggettInternalPHP: Use the PECL extension
4265 * - RaggettExternal: Shell out to an external binary (tidyBin)
4266 * - Html5Depurate: Use external Depurate service
4267 * - Html5Internal: Use the Balancer library in PHP
4268 * - RemexHtml: Use the RemexHtml library in PHP
4270 * - tidyConfigFile: Path to configuration file for any of the Raggett drivers
4271 * - debugComment: True to add a comment to the output with warning messages
4272 * - tidyBin: For RaggettExternal, the path to the tidy binary.
4273 * - tidyCommandLine: For RaggettExternal, additional command line options.
4275 $wgTidyConfig = null;
4278 * Set this to true to use the deprecated tidy configuration parameters.
4279 * @deprecated use $wgTidyConfig
4284 * The path to the tidy binary.
4285 * @deprecated Use $wgTidyConfig['tidyBin']
4287 $wgTidyBin = 'tidy';
4290 * The path to the tidy config file
4291 * @deprecated Use $wgTidyConfig['tidyConfigFile']
4293 $wgTidyConf = $IP . '/includes/tidy/tidy.conf';
4296 * The command line options to the tidy binary
4297 * @deprecated Use $wgTidyConfig['tidyCommandLine']
4302 * Set this to true to use the tidy extension
4303 * @deprecated Use $wgTidyConfig['driver']
4305 $wgTidyInternal = extension_loaded( 'tidy' );
4308 * Put tidy warnings in HTML comments
4309 * Only works for internal tidy.
4311 $wgDebugTidy = false;
4314 * Allow raw, unchecked HTML in "<html>...</html>" sections.
4315 * THIS IS VERY DANGEROUS on a publicly editable site, so USE wgGroupPermissions
4316 * TO RESTRICT EDITING to only those that you trust
4321 * Set a default target for external links, e.g. _blank to pop up a new window.
4323 * This will also set the "noreferrer" and "noopener" link rel to prevent the
4324 * attack described at https://mathiasbynens.github.io/rel-noopener/ .
4325 * Some older browsers may not support these link attributes, hence
4326 * setting $wgExternalLinkTarget to _blank may represent a security risk
4327 * to some of your users.
4329 $wgExternalLinkTarget = false;
4332 * If true, external URL links in wiki text will be given the
4333 * rel="nofollow" attribute as a hint to search engines that
4334 * they should not be followed for ranking purposes as they
4335 * are user-supplied and thus subject to spamming.
4337 $wgNoFollowLinks = true;
4340 * Namespaces in which $wgNoFollowLinks doesn't apply.
4341 * See Language.php for a list of namespaces.
4343 $wgNoFollowNsExceptions = [];
4346 * If this is set to an array of domains, external links to these domain names
4347 * (or any subdomains) will not be set to rel="nofollow" regardless of the
4348 * value of $wgNoFollowLinks. For instance:
4350 * $wgNoFollowDomainExceptions = [ 'en.wikipedia.org', 'wiktionary.org', 'mediawiki.org' ];
4352 * This would add rel="nofollow" to links to de.wikipedia.org, but not
4353 * en.wikipedia.org, wiktionary.org, en.wiktionary.org, us.en.wikipedia.org,
4356 * Defaults to mediawiki.org for the links included in the software by default.
4358 $wgNoFollowDomainExceptions = [ 'mediawiki.org' ];
4361 * Allow DISPLAYTITLE to change title display
4363 $wgAllowDisplayTitle = true;
4366 * For consistency, restrict DISPLAYTITLE to text that normalizes to the same
4367 * canonical DB key. Also disallow some inline CSS rules like display: none;
4368 * which can cause the text to be hidden or unselectable.
4370 $wgRestrictDisplayTitle = true;
4373 * Maximum number of calls per parse to expensive parser functions such as
4376 $wgExpensiveParserFunctionLimit = 100;
4379 * Preprocessor caching threshold
4380 * Setting it to 'false' will disable the preprocessor cache.
4382 $wgPreprocessorCacheThreshold = 1000;
4385 * Enable interwiki transcluding. Only when iw_trans=1 in the interwiki table.
4387 $wgEnableScaryTranscluding = false;
4390 * Expiry time for transcluded templates cached in transcache database table.
4391 * Only used $wgEnableInterwikiTranscluding is set to true.
4393 $wgTranscludeCacheExpiry = 3600;
4396 * Enable the magic links feature of automatically turning ISBN xxx,
4397 * PMID xxx, RFC xxx into links
4401 $wgEnableMagicLinks = [
4407 /** @} */ # end of parser settings }
4409 /************************************************************************//**
4415 * Method used to determine if a page in a content namespace should be counted
4416 * as a valid article.
4418 * Redirect pages will never be counted as valid articles.
4420 * This variable can have the following values:
4421 * - 'any': all pages as considered as valid articles
4422 * - 'comma': the page must contain a comma to be considered valid
4423 * - 'link': the page must contain a [[wiki link]] to be considered valid
4425 * See also See https://www.mediawiki.org/wiki/Manual:Article_count
4427 * Retroactively changing this variable will not affect the existing count,
4428 * to update it, you will need to run the maintenance/updateArticleCount.php
4431 $wgArticleCountMethod = 'link';
4434 * How many days user must be idle before he is considered inactive. Will affect
4435 * the number shown on Special:Statistics, Special:ActiveUsers, and the
4436 * {{NUMBEROFACTIVEUSERS}} magic word in wikitext.
4437 * You might want to leave this as the default value, to provide comparable
4438 * numbers between different wikis.
4440 $wgActiveUserDays = 30;
4442 /** @} */ # End of statistics }
4444 /************************************************************************//**
4445 * @name User accounts, authentication
4450 * Central ID lookup providers
4451 * Key is the provider ID, value is a specification for ObjectFactory
4454 $wgCentralIdLookupProviders = [
4455 'local' => [ 'class' => 'LocalIdLookup' ],
4459 * Central ID lookup provider to use by default
4462 $wgCentralIdLookupProvider = 'local';
4465 * Password policy for local wiki users. A user's effective policy
4466 * is the superset of all policy statements from the policies for the
4467 * groups where the user is a member. If more than one group policy
4468 * include the same policy statement, the value is the max() of the
4469 * values. Note true > false. The 'default' policy group is required,
4470 * and serves as the minimum policy for all users. New statements can
4471 * be added by appending to $wgPasswordPolicy['checks'].
4473 * - MinimalPasswordLength - minimum length a user can set
4474 * - MinimumPasswordLengthToLogin - passwords shorter than this will
4475 * not be allowed to login, regardless if it is correct.
4476 * - MaximalPasswordLength - maximum length password a user is allowed
4477 * to attempt. Prevents DoS attacks with pbkdf2.
4478 * - PasswordCannotMatchUsername - Password cannot match username to
4479 * - PasswordCannotMatchBlacklist - Username/password combination cannot
4480 * match a specific, hardcoded blacklist.
4481 * - PasswordCannotBePopular - Blacklist passwords which are known to be
4482 * commonly chosen. Set to integer n to ban the top n passwords.
4483 * If you want to ban all common passwords on file, use the
4484 * PHP_INT_MAX constant.
4487 $wgPasswordPolicy = [
4490 'MinimalPasswordLength' => 8,
4491 'MinimumPasswordLengthToLogin' => 1,
4492 'PasswordCannotMatchUsername' => true,
4493 'PasswordCannotBePopular' => 25,
4496 'MinimalPasswordLength' => 8,
4497 'MinimumPasswordLengthToLogin' => 1,
4498 'PasswordCannotMatchUsername' => true,
4499 'PasswordCannotBePopular' => 25,
4502 'MinimalPasswordLength' => 8,
4503 'MinimumPasswordLengthToLogin' => 1,
4504 'PasswordCannotMatchUsername' => true,
4507 'MinimalPasswordLength' => 1,
4508 'PasswordCannotMatchUsername' => true,
4509 'PasswordCannotMatchBlacklist' => true,
4510 'MaximalPasswordLength' => 4096,
4514 'MinimalPasswordLength' => 'PasswordPolicyChecks::checkMinimalPasswordLength',
4515 'MinimumPasswordLengthToLogin' => 'PasswordPolicyChecks::checkMinimumPasswordLengthToLogin',
4516 'PasswordCannotMatchUsername' => 'PasswordPolicyChecks::checkPasswordCannotMatchUsername',
4517 'PasswordCannotMatchBlacklist' => 'PasswordPolicyChecks::checkPasswordCannotMatchBlacklist',
4518 'MaximalPasswordLength' => 'PasswordPolicyChecks::checkMaximalPasswordLength',
4519 'PasswordCannotBePopular' => 'PasswordPolicyChecks::checkPopularPasswordBlacklist'
4524 * Configure AuthManager
4526 * All providers are constructed using ObjectFactory, see that for the general
4527 * structure. The array may also contain a key "sort" used to order providers:
4528 * providers are stably sorted by this value, which should be an integer
4532 * - preauth: Array (keys ignored) of specifications for PreAuthenticationProviders
4533 * - primaryauth: Array (keys ignored) of specifications for PrimaryAuthenticationProviders
4534 * - secondaryauth: Array (keys ignored) of specifications for SecondaryAuthenticationProviders
4537 * @note If this is null or empty, the value from $wgAuthManagerAutoConfig is
4538 * used instead. Local customization should generally set this variable from
4539 * scratch to the desired configuration. Extensions that want to
4540 * auto-configure themselves should use $wgAuthManagerAutoConfig instead.
4542 $wgAuthManagerConfig = null;
4545 * @see $wgAuthManagerConfig
4548 $wgAuthManagerAutoConfig = [
4550 MediaWiki\Auth\LegacyHookPreAuthenticationProvider
::class => [
4551 'class' => MediaWiki\Auth\LegacyHookPreAuthenticationProvider
::class,
4554 MediaWiki\Auth\ThrottlePreAuthenticationProvider
::class => [
4555 'class' => MediaWiki\Auth\ThrottlePreAuthenticationProvider
::class,
4560 // TemporaryPasswordPrimaryAuthenticationProvider should come before
4561 // any other PasswordAuthenticationRequest-based
4562 // PrimaryAuthenticationProvider (or at least any that might return
4563 // FAIL rather than ABSTAIN for a wrong password), or password reset
4564 // won't work right. Do not remove this (or change the key) or
4565 // auto-configuration of other such providers in extensions will
4566 // probably auto-insert themselves in the wrong place.
4567 MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider
::class => [
4568 'class' => MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider
::class,
4570 // Fall through to LocalPasswordPrimaryAuthenticationProvider
4571 'authoritative' => false,
4575 MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider
::class => [
4576 'class' => MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider
::class,
4578 // Last one should be authoritative, or else the user will get
4579 // a less-than-helpful error message (something like "supplied
4580 // authentication info not supported" rather than "wrong
4581 // password") if it too fails.
4582 'authoritative' => true,
4587 'secondaryauth' => [
4588 MediaWiki\Auth\CheckBlocksSecondaryAuthenticationProvider
::class => [
4589 'class' => MediaWiki\Auth\CheckBlocksSecondaryAuthenticationProvider
::class,
4592 MediaWiki\Auth\ResetPasswordSecondaryAuthenticationProvider
::class => [
4593 'class' => MediaWiki\Auth\ResetPasswordSecondaryAuthenticationProvider
::class,
4596 // Linking during login is experimental, enable at your own risk - T134952
4597 // MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider::class => [
4598 // 'class' => MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider::class,
4601 MediaWiki\Auth\EmailNotificationSecondaryAuthenticationProvider
::class => [
4602 'class' => MediaWiki\Auth\EmailNotificationSecondaryAuthenticationProvider
::class,
4609 * Time frame for re-authentication.
4611 * With only password-based authentication, you'd just ask the user to re-enter
4612 * their password to verify certain operations like changing the password or
4613 * changing the account's email address. But under AuthManager, the user might
4614 * not have a password (you might even have to redirect the browser to a
4615 * third-party service or something complex like that), you might want to have
4616 * both factors of a two-factor authentication, and so on. So, the options are:
4617 * - Incorporate the whole multi-step authentication flow within everything
4618 * that needs to do this.
4619 * - Consider it good if they used Special:UserLogin during this session within
4620 * the last X seconds.
4621 * - Come up with a third option.
4623 * MediaWiki currently takes the second option. This setting configures the
4626 * This allows for configuring different time frames for different
4627 * "operations". The operations used in MediaWiki core include:
4630 * - ChangeCredentials
4631 * - RemoveCredentials
4634 * Additional operations may be used by extensions, either explicitly by
4635 * calling AuthManager::securitySensitiveOperationStatus(),
4636 * ApiAuthManagerHelper::securitySensitiveOperation() or
4637 * SpecialPage::checkLoginSecurityLevel(), or implicitly by overriding
4638 * SpecialPage::getLoginSecurityLevel() or by subclassing
4639 * AuthManagerSpecialPage.
4641 * The key 'default' is used if a requested operation isn't defined in the array.
4644 * @var int[] operation => time in seconds. A 'default' key must always be provided.
4646 $wgReauthenticateTime = [
4651 * Whether to allow security-sensitive operations when re-authentication is not possible.
4653 * If AuthManager::canAuthenticateNow() is false (e.g. the current
4654 * SessionProvider is not able to change users, such as when OAuth is in use),
4655 * AuthManager::securitySensitiveOperationStatus() cannot sensibly return
4656 * SEC_REAUTH. Setting an operation true here will have it return SEC_OK in
4657 * that case, while setting it false will have it return SEC_FAIL.
4659 * The key 'default' is used if a requested operation isn't defined in the array.
4662 * @see $wgReauthenticateTime
4663 * @var bool[] operation => boolean. A 'default' key must always be provided.
4665 $wgAllowSecuritySensitiveOperationIfCannotReauthenticate = [
4670 * List of AuthenticationRequest class names which are not changeable through
4671 * Special:ChangeCredentials and the changeauthenticationdata API.
4672 * This is only enforced on the client level; AuthManager itself (e.g.
4673 * AuthManager::allowsAuthenticationDataChange calls) is not affected.
4674 * Class names are checked for exact match (not for subclasses).
4678 $wgChangeCredentialsBlacklist = [
4679 \MediaWiki\Auth\TemporaryPasswordAuthenticationRequest
::class
4683 * List of AuthenticationRequest class names which are not removable through
4684 * Special:RemoveCredentials and the removeauthenticationdata API.
4685 * This is only enforced on the client level; AuthManager itself (e.g.
4686 * AuthManager::allowsAuthenticationDataChange calls) is not affected.
4687 * Class names are checked for exact match (not for subclasses).
4691 $wgRemoveCredentialsBlacklist = [
4692 \MediaWiki\Auth\PasswordAuthenticationRequest
::class,
4696 * For compatibility with old installations set to false
4697 * @deprecated since 1.24 will be removed in future
4699 $wgPasswordSalt = true;
4702 * Specifies the minimal length of a user password. If set to 0, empty pass-
4703 * words are allowed.
4704 * @deprecated since 1.26, use $wgPasswordPolicy's MinimalPasswordLength.
4706 $wgMinimalPasswordLength = false;
4709 * Specifies the maximal length of a user password (T64685).
4711 * It is not recommended to make this greater than the default, as it can
4712 * allow DoS attacks by users setting really long passwords. In addition,
4713 * this should not be lowered too much, as it enforces weak passwords.
4715 * @warning Unlike other password settings, user with passwords greater than
4716 * the maximum will not be able to log in.
4717 * @deprecated since 1.26, use $wgPasswordPolicy's MaximalPasswordLength.
4719 $wgMaximalPasswordLength = false;
4722 * Specifies if users should be sent to a password-reset form on login, if their
4723 * password doesn't meet the requirements of User::isValidPassword().
4726 $wgInvalidPasswordReset = true;
4729 * Default password type to use when hashing user passwords
4733 $wgPasswordDefault = 'pbkdf2';
4736 * Configuration for built-in password types. Maps the password type
4737 * to an array of options. The 'class' option is the Password class to
4738 * use. All other options are class-dependent.
4740 * An advanced example:
4742 * $wgPasswordConfig['bcrypt-peppered'] = [
4743 * 'class' => 'EncryptedPassword',
4744 * 'underlying' => 'bcrypt',
4746 * 'cipher' => MCRYPT_RIJNDAEL_256,
4747 * 'mode' => MCRYPT_MODE_CBC,
4754 $wgPasswordConfig = [
4756 'class' => 'MWOldPassword',
4759 'class' => 'MWSaltedPassword',
4761 'pbkdf2-legacyA' => [
4762 'class' => 'LayeredParameterizedPassword',
4768 'pbkdf2-legacyB' => [
4769 'class' => 'LayeredParameterizedPassword',
4776 'class' => 'BcryptPassword',
4780 'class' => 'Pbkdf2Password',
4788 * Whether to allow password resets ("enter some identifying data, and we'll send an email
4789 * with a temporary password you can use to get back into the account") identified by
4790 * various bits of data. Setting all of these to false (or the whole variable to false)
4791 * has the effect of disabling password resets entirely
4793 $wgPasswordResetRoutes = [
4799 * Maximum number of Unicode characters in signature
4801 $wgMaxSigChars = 255;
4804 * Maximum number of bytes in username. You want to run the maintenance
4805 * script ./maintenance/checkUsernames.php once you have changed this value.
4807 $wgMaxNameChars = 255;
4810 * Array of usernames which may not be registered or logged in from
4811 * Maintenance scripts can still use these
4813 $wgReservedUsernames = [
4814 'MediaWiki default', // Default 'Main Page' and MediaWiki: message pages
4815 'Conversion script', // Used for the old Wikipedia software upgrade
4816 'Maintenance script', // Maintenance scripts which perform editing, image import script
4817 'Template namespace initialisation script', // Used in 1.2->1.3 upgrade
4818 'ScriptImporter', // Default user name used by maintenance/importSiteScripts.php
4819 'Unknown user', // Used in WikiImporter when importing revisions with no author
4820 'msg:double-redirect-fixer', // Automatic double redirect fix
4821 'msg:usermessage-editor', // Default user for leaving user messages
4822 'msg:proxyblocker', // For $wgProxyList and Special:Blockme (removed in 1.22)
4823 'msg:spambot_username', // Used by cleanupSpam.php
4824 'msg:autochange-username', // Used by anon category RC entries (parser functions, Lua & purges)
4828 * Settings added to this array will override the default globals for the user
4829 * preferences used by anonymous visitors and newly created accounts.
4830 * For instance, to disable editing on double clicks:
4831 * $wgDefaultUserOptions ['editondblclick'] = 0;
4833 $wgDefaultUserOptions = [
4834 'ccmeonemails' => 0,
4835 'cols' => 80, // @deprecated since 1.29 No longer used in core
4836 'date' => 'default',
4839 'editfont' => 'default',
4840 'editondblclick' => 0,
4841 'editsectiononrightclick' => 0,
4842 'enotifminoredits' => 0,
4843 'enotifrevealaddr' => 0,
4844 'enotifusertalkpages' => 1,
4845 'enotifwatchlistpages' => 1,
4846 'extendwatchlist' => 1,
4848 'forceeditsummary' => 0,
4849 'gender' => 'unknown',
4851 'hidepatrolled' => 0,
4852 'hidecategorization' => 1,
4855 'minordefault' => 0,
4856 'newpageshidepatrolled' => 0,
4858 'norollbackdiff' => 0,
4859 'numberheadings' => 0,
4860 'previewonfirst' => 0,
4861 'previewontop' => 1,
4863 'rcenhancedfilters' => 0,
4865 'rows' => 25, // @deprecated since 1.29 No longer used in core
4866 'showhiddencats' => 0,
4867 'shownumberswatching' => 1,
4870 'stubthreshold' => 0,
4873 'uselivepreview' => 0,
4875 'watchcreations' => 1,
4876 'watchdefault' => 1,
4877 'watchdeletion' => 0,
4878 'watchuploads' => 1,
4879 'watchlistdays' => 3.0,
4880 'watchlisthideanons' => 0,
4881 'watchlisthidebots' => 0,
4882 'watchlisthideliu' => 0,
4883 'watchlisthideminor' => 0,
4884 'watchlisthideown' => 0,
4885 'watchlisthidepatrolled' => 0,
4886 'watchlisthidecategorization' => 1,
4887 'watchlistreloadautomatically' => 0,
4889 'watchrollback' => 0,
4891 'useeditwarning' => 1,
4892 'prefershttps' => 1,
4896 * An array of preferences to not show for the user
4898 $wgHiddenPrefs = [];
4901 * Characters to prevent during new account creations.
4902 * This is used in a regular expression character class during
4903 * registration (regex metacharacters like / are escaped).
4905 $wgInvalidUsernameCharacters = '@:';
4908 * Character used as a delimiter when testing for interwiki userrights
4909 * (In Special:UserRights, it is possible to modify users on different
4910 * databases if the delimiter is used, e.g. "Someuser@enwiki").
4912 * It is recommended that you have this delimiter in
4913 * $wgInvalidUsernameCharacters above, or you will not be able to
4914 * modify the user rights of those users via Special:UserRights
4916 $wgUserrightsInterwikiDelimiter = '@';
4919 * This is to let user authenticate using https when they come from http.
4920 * Based on an idea by George Herbert on wikitech-l:
4921 * https://lists.wikimedia.org/pipermail/wikitech-l/2010-October/050039.html
4924 $wgSecureLogin = false;
4927 * Versioning for authentication tokens.
4929 * If non-null, this is combined with the user's secret (the user_token field
4930 * in the DB) to generate the token cookie. Changing this will invalidate all
4931 * active sessions (i.e. it will log everyone out).
4936 $wgAuthenticationTokenVersion = null;
4939 * MediaWiki\Session\SessionProvider configuration.
4941 * Value is an array of ObjectFactory specifications for the SessionProviders
4942 * to be used. Keys in the array are ignored. Order is not significant.
4946 $wgSessionProviders = [
4947 MediaWiki\Session\CookieSessionProvider
::class => [
4948 'class' => MediaWiki\Session\CookieSessionProvider
::class,
4951 'callUserSetCookiesHook' => true,
4954 MediaWiki\Session\BotPasswordSessionProvider
::class => [
4955 'class' => MediaWiki\Session\BotPasswordSessionProvider
::class,
4962 /** @} */ # end user accounts }
4964 /************************************************************************//**
4965 * @name User rights, access control and monitoring
4970 * Number of seconds before autoblock entries expire. Default 86400 = 1 day.
4972 $wgAutoblockExpiry = 86400;
4975 * Set this to true to allow blocked users to edit their own user talk page.
4977 $wgBlockAllowsUTEdit = true;
4980 * Allow sysops to ban users from accessing Emailuser
4982 $wgSysopEmailBans = true;
4985 * Limits on the possible sizes of range blocks.
4987 * CIDR notation is hard to understand, it's easy to mistakenly assume that a
4988 * /1 is a small range and a /31 is a large range. For IPv4, setting a limit of
4989 * half the number of bits avoids such errors, and allows entire ISPs to be
4990 * blocked using a small number of range blocks.
4992 * For IPv6, RFC 3177 recommends that a /48 be allocated to every residential
4993 * customer, so range blocks larger than /64 (half the number of bits) will
4994 * plainly be required. RFC 4692 implies that a very large ISP may be
4995 * allocated a /19 if a generous HD-Ratio of 0.8 is used, so we will use that
4996 * as our limit. As of 2012, blocking the whole world would require a /4 range.
4998 $wgBlockCIDRLimit = [
4999 'IPv4' => 16, # Blocks larger than a /16 (64k addresses) will not be allowed
5004 * If true, blocked users will not be allowed to login. When using this with
5005 * a public wiki, the effect of logging out blocked users may actually be
5006 * avers: unless the user's address is also blocked (e.g. auto-block),
5007 * logging the user out will again allow reading and editing, just as for
5008 * anonymous visitors.
5010 $wgBlockDisablesLogin = false;
5013 * Pages anonymous user may see, set as an array of pages titles.
5017 * $wgWhitelistRead = array ( "Main Page", "Wikipedia:Help");
5020 * Special:Userlogin and Special:ChangePassword are always whitelisted.
5022 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
5023 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
5025 * @note Also that this will only protect _pages in the wiki_. Uploaded files
5026 * will remain readable. You can use img_auth.php to protect uploaded files,
5027 * see https://www.mediawiki.org/wiki/Manual:Image_Authorization
5029 $wgWhitelistRead = false;
5032 * Pages anonymous user may see, set as an array of regular expressions.
5034 * This function will match the regexp against the title name, which
5035 * is without underscore.
5038 * To whitelist [[Main Page]]:
5040 * $wgWhitelistReadRegexp = [ "/Main Page/" ];
5043 * @note Unless ^ and/or $ is specified, a regular expression might match
5044 * pages not intended to be whitelisted. The above example will also
5045 * whitelist a page named 'Security Main Page'.
5048 * To allow reading any page starting with 'User' regardless of the case:
5050 * $wgWhitelistReadRegexp = [ "@^UsEr.*@i" ];
5052 * Will allow both [[User is banned]] and [[User:JohnDoe]]
5054 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
5055 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
5057 $wgWhitelistReadRegexp = false;
5060 * Should editors be required to have a validated e-mail
5061 * address before being allowed to edit?
5063 $wgEmailConfirmToEdit = false;
5066 * Should MediaWiki attempt to protect user's privacy when doing redirects?
5067 * Keep this true if access counts to articles are made public.
5069 $wgHideIdentifiableRedirects = true;
5072 * Permission keys given to users in each group.
5074 * This is an array where the keys are all groups and each value is an
5075 * array of the format (right => boolean).
5077 * The second format is used to support per-namespace permissions.
5078 * Note that this feature does not fully work for all permission types.
5080 * All users are implicitly in the '*' group including anonymous visitors;
5081 * logged-in users are all implicitly in the 'user' group. These will be
5082 * combined with the permissions of all groups that a given user is listed
5083 * in in the user_groups table.
5085 * Note: Don't set $wgGroupPermissions = []; unless you know what you're
5086 * doing! This will wipe all permissions, and may mean that your users are
5087 * unable to perform certain essential tasks or access new functionality
5088 * when new permissions are introduced and default grants established.
5090 * Functionality to make pages inaccessible has not been extensively tested
5091 * for security. Use at your own risk!
5093 * This replaces $wgWhitelistAccount and $wgWhitelistEdit
5095 $wgGroupPermissions = [];
5097 /** @cond file_level_code */
5098 // Implicit group for all visitors
5099 $wgGroupPermissions['*']['createaccount'] = true;
5100 $wgGroupPermissions['*']['read'] = true;
5101 $wgGroupPermissions['*']['edit'] = true;
5102 $wgGroupPermissions['*']['createpage'] = true;
5103 $wgGroupPermissions['*']['createtalk'] = true;
5104 $wgGroupPermissions['*']['writeapi'] = true;
5105 $wgGroupPermissions['*']['editmyusercss'] = true;
5106 $wgGroupPermissions['*']['editmyuserjs'] = true;
5107 $wgGroupPermissions['*']['viewmywatchlist'] = true;
5108 $wgGroupPermissions['*']['editmywatchlist'] = true;
5109 $wgGroupPermissions['*']['viewmyprivateinfo'] = true;
5110 $wgGroupPermissions['*']['editmyprivateinfo'] = true;
5111 $wgGroupPermissions['*']['editmyoptions'] = true;
5112 # $wgGroupPermissions['*']['patrolmarks'] = false; // let anons see what was patrolled
5114 // Implicit group for all logged-in accounts
5115 $wgGroupPermissions['user']['move'] = true;
5116 $wgGroupPermissions['user']['move-subpages'] = true;
5117 $wgGroupPermissions['user']['move-rootuserpages'] = true; // can move root userpages
5118 $wgGroupPermissions['user']['move-categorypages'] = true;
5119 $wgGroupPermissions['user']['movefile'] = true;
5120 $wgGroupPermissions['user']['read'] = true;
5121 $wgGroupPermissions['user']['edit'] = true;
5122 $wgGroupPermissions['user']['createpage'] = true;
5123 $wgGroupPermissions['user']['createtalk'] = true;
5124 $wgGroupPermissions['user']['writeapi'] = true;
5125 $wgGroupPermissions['user']['upload'] = true;
5126 $wgGroupPermissions['user']['reupload'] = true;
5127 $wgGroupPermissions['user']['reupload-shared'] = true;
5128 $wgGroupPermissions['user']['minoredit'] = true;
5129 $wgGroupPermissions['user']['purge'] = true;
5130 $wgGroupPermissions['user']['sendemail'] = true;
5131 $wgGroupPermissions['user']['applychangetags'] = true;
5132 $wgGroupPermissions['user']['changetags'] = true;
5133 $wgGroupPermissions['user']['editcontentmodel'] = true;
5135 // Implicit group for accounts that pass $wgAutoConfirmAge
5136 $wgGroupPermissions['autoconfirmed']['autoconfirmed'] = true;
5137 $wgGroupPermissions['autoconfirmed']['editsemiprotected'] = true;
5139 // Users with bot privilege can have their edits hidden
5140 // from various log pages by default
5141 $wgGroupPermissions['bot']['bot'] = true;
5142 $wgGroupPermissions['bot']['autoconfirmed'] = true;
5143 $wgGroupPermissions['bot']['editsemiprotected'] = true;
5144 $wgGroupPermissions['bot']['nominornewtalk'] = true;
5145 $wgGroupPermissions['bot']['autopatrol'] = true;
5146 $wgGroupPermissions['bot']['suppressredirect'] = true;
5147 $wgGroupPermissions['bot']['apihighlimits'] = true;
5148 $wgGroupPermissions['bot']['writeapi'] = true;
5150 // Most extra permission abilities go to this group
5151 $wgGroupPermissions['sysop']['block'] = true;
5152 $wgGroupPermissions['sysop']['createaccount'] = true;
5153 $wgGroupPermissions['sysop']['delete'] = true;
5154 // can be separately configured for pages with > $wgDeleteRevisionsLimit revs
5155 $wgGroupPermissions['sysop']['bigdelete'] = true;
5156 // can view deleted history entries, but not see or restore the text
5157 $wgGroupPermissions['sysop']['deletedhistory'] = true;
5158 // can view deleted revision text
5159 $wgGroupPermissions['sysop']['deletedtext'] = true;
5160 $wgGroupPermissions['sysop']['undelete'] = true;
5161 $wgGroupPermissions['sysop']['editinterface'] = true;
5162 $wgGroupPermissions['sysop']['editusercss'] = true;
5163 $wgGroupPermissions['sysop']['edituserjs'] = true;
5164 $wgGroupPermissions['sysop']['import'] = true;
5165 $wgGroupPermissions['sysop']['importupload'] = true;
5166 $wgGroupPermissions['sysop']['move'] = true;
5167 $wgGroupPermissions['sysop']['move-subpages'] = true;
5168 $wgGroupPermissions['sysop']['move-rootuserpages'] = true;
5169 $wgGroupPermissions['sysop']['move-categorypages'] = true;
5170 $wgGroupPermissions['sysop']['patrol'] = true;
5171 $wgGroupPermissions['sysop']['autopatrol'] = true;
5172 $wgGroupPermissions['sysop']['protect'] = true;
5173 $wgGroupPermissions['sysop']['editprotected'] = true;
5174 $wgGroupPermissions['sysop']['rollback'] = true;
5175 $wgGroupPermissions['sysop']['upload'] = true;
5176 $wgGroupPermissions['sysop']['reupload'] = true;
5177 $wgGroupPermissions['sysop']['reupload-shared'] = true;
5178 $wgGroupPermissions['sysop']['unwatchedpages'] = true;
5179 $wgGroupPermissions['sysop']['autoconfirmed'] = true;
5180 $wgGroupPermissions['sysop']['editsemiprotected'] = true;
5181 $wgGroupPermissions['sysop']['ipblock-exempt'] = true;
5182 $wgGroupPermissions['sysop']['blockemail'] = true;
5183 $wgGroupPermissions['sysop']['markbotedits'] = true;
5184 $wgGroupPermissions['sysop']['apihighlimits'] = true;
5185 $wgGroupPermissions['sysop']['browsearchive'] = true;
5186 $wgGroupPermissions['sysop']['noratelimit'] = true;
5187 $wgGroupPermissions['sysop']['movefile'] = true;
5188 $wgGroupPermissions['sysop']['unblockself'] = true;
5189 $wgGroupPermissions['sysop']['suppressredirect'] = true;
5190 # $wgGroupPermissions['sysop']['pagelang'] = true;
5191 # $wgGroupPermissions['sysop']['upload_by_url'] = true;
5192 $wgGroupPermissions['sysop']['mergehistory'] = true;
5193 $wgGroupPermissions['sysop']['managechangetags'] = true;
5194 $wgGroupPermissions['sysop']['deletechangetags'] = true;
5196 // Permission to change users' group assignments
5197 $wgGroupPermissions['bureaucrat']['userrights'] = true;
5198 $wgGroupPermissions['bureaucrat']['noratelimit'] = true;
5199 // Permission to change users' groups assignments across wikis
5200 # $wgGroupPermissions['bureaucrat']['userrights-interwiki'] = true;
5201 // Permission to export pages including linked pages regardless of $wgExportMaxLinkDepth
5202 # $wgGroupPermissions['bureaucrat']['override-export-depth'] = true;
5204 # $wgGroupPermissions['sysop']['deletelogentry'] = true;
5205 # $wgGroupPermissions['sysop']['deleterevision'] = true;
5206 // To hide usernames from users and Sysops
5207 # $wgGroupPermissions['suppress']['hideuser'] = true;
5208 // To hide revisions/log items from users and Sysops
5209 # $wgGroupPermissions['suppress']['suppressrevision'] = true;
5210 // To view revisions/log items hidden from users and Sysops
5211 # $wgGroupPermissions['suppress']['viewsuppressed'] = true;
5212 // For private suppression log access
5213 # $wgGroupPermissions['suppress']['suppressionlog'] = true;
5216 * The developer group is deprecated, but can be activated if need be
5217 * to use the 'lockdb' and 'unlockdb' special pages. Those require
5218 * that a lock file be defined and creatable/removable by the web
5221 # $wgGroupPermissions['developer']['siteadmin'] = true;
5226 * Permission keys revoked from users in each group.
5228 * This acts the same way as wgGroupPermissions above, except that
5229 * if the user is in a group here, the permission will be removed from them.
5231 * Improperly setting this could mean that your users will be unable to perform
5232 * certain essential tasks, so use at your own risk!
5234 $wgRevokePermissions = [];
5237 * Implicit groups, aren't shown on Special:Listusers or somewhere else
5239 $wgImplicitGroups = [ '*', 'user', 'autoconfirmed' ];
5242 * A map of group names that the user is in, to group names that those users
5243 * are allowed to add or revoke.
5245 * Setting the list of groups to add or revoke to true is equivalent to "any
5249 * To allow sysops to add themselves to the "bot" group:
5251 * $wgGroupsAddToSelf = [ 'sysop' => [ 'bot' ] ];
5255 * Implicit groups may be used for the source group, for instance:
5257 * $wgGroupsRemoveFromSelf = [ '*' => true ];
5259 * This allows users in the '*' group (i.e. any user) to remove themselves from
5260 * any group that they happen to be in.
5262 $wgGroupsAddToSelf = [];
5265 * @see $wgGroupsAddToSelf
5267 $wgGroupsRemoveFromSelf = [];
5270 * Set of available actions that can be restricted via action=protect
5271 * You probably shouldn't change this.
5272 * Translated through restriction-* messages.
5273 * Title::getRestrictionTypes() will remove restrictions that are not
5274 * applicable to a specific title (create and upload)
5276 $wgRestrictionTypes = [ 'create', 'edit', 'move', 'upload' ];
5279 * Rights which can be required for each protection level (via action=protect)
5281 * You can add a new protection level that requires a specific
5282 * permission by manipulating this array. The ordering of elements
5283 * dictates the order on the protection form's lists.
5285 * - '' will be ignored (i.e. unprotected)
5286 * - 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility
5287 * - 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility
5289 $wgRestrictionLevels = [ '', 'autoconfirmed', 'sysop' ];
5292 * Restriction levels that can be used with cascading protection
5294 * A page can only be protected with cascading protection if the
5295 * requested restriction level is included in this array.
5297 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
5298 * 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility.
5300 $wgCascadingRestrictionLevels = [ 'sysop' ];
5303 * Restriction levels that should be considered "semiprotected"
5305 * Certain places in the interface recognize a dichotomy between "protected"
5306 * and "semiprotected", without further distinguishing the specific levels. In
5307 * general, if anyone can be eligible to edit a protection level merely by
5308 * reaching some condition in $wgAutopromote, it should probably be considered
5311 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
5312 * 'sysop' is not changed, since it really shouldn't be here.
5314 $wgSemiprotectedRestrictionLevels = [ 'autoconfirmed' ];
5317 * Set the minimum permissions required to edit pages in each
5318 * namespace. If you list more than one permission, a user must
5319 * have all of them to edit pages in that namespace.
5321 * @note NS_MEDIAWIKI is implicitly restricted to 'editinterface'.
5323 $wgNamespaceProtection = [];
5326 * Pages in namespaces in this array can not be used as templates.
5328 * Elements MUST be numeric namespace ids, you can safely use the MediaWiki
5329 * namespaces constants (NS_USER, NS_MAIN...).
5331 * Among other things, this may be useful to enforce read-restrictions
5332 * which may otherwise be bypassed by using the template mechanism.
5334 $wgNonincludableNamespaces = [];
5337 * Number of seconds an account is required to age before it's given the
5338 * implicit 'autoconfirm' group membership. This can be used to limit
5339 * privileges of new accounts.
5341 * Accounts created by earlier versions of the software may not have a
5342 * recorded creation date, and will always be considered to pass the age test.
5344 * When left at 0, all registered accounts will pass.
5347 * Set automatic confirmation to 10 minutes (which is 600 seconds):
5349 * $wgAutoConfirmAge = 600; // ten minutes
5351 * Set age to one day:
5353 * $wgAutoConfirmAge = 3600*24; // one day
5356 $wgAutoConfirmAge = 0;
5359 * Number of edits an account requires before it is autoconfirmed.
5360 * Passing both this AND the time requirement is needed. Example:
5364 * $wgAutoConfirmCount = 50;
5367 $wgAutoConfirmCount = 0;
5370 * Array containing the conditions of automatic promotion of a user to specific groups.
5372 * The basic syntax for `$wgAutopromote` is:
5374 * $wgAutopromote = array(
5375 * 'groupname' => cond,
5376 * 'group2' => cond2,
5380 * - a single condition without arguments:
5381 * Note that Autopromote wraps a single non-array value into an array
5382 * e.g. `APCOND_EMAILCONFIRMED` OR
5383 * array( `APCOND_EMAILCONFIRMED` )
5384 * - a single condition with arguments:
5385 * e.g. `array( APCOND_EDITCOUNT, 100 )`
5386 * - a set of conditions:
5387 * e.g. `array( 'operand', cond1, cond2, ... )`
5389 * When constructing a set of conditions, the following conditions are available:
5391 * promote if user matches **ALL** conditions
5393 * promote if user matches **ANY** condition
5395 * promote if user matches **ONLY ONE OF THE CONDITIONS**
5397 * promote if user matces **NO** condition
5398 * - array( APCOND_EMAILCONFIRMED ):
5399 * true if user has a confirmed e-mail
5400 * - array( APCOND_EDITCOUNT, number of edits ):
5401 * true if user has the at least the number of edits as the passed parameter
5402 * - array( APCOND_AGE, seconds since registration ):
5403 * true if the length of time since the user created his/her account
5404 * is at least the same length of time as the passed parameter
5405 * - array( APCOND_AGE_FROM_EDIT, seconds since first edit ):
5406 * true if the length of time since the user made his/her first edit
5407 * is at least the same length of time as the passed parameter
5408 * - array( APCOND_INGROUPS, group1, group2, ... ):
5409 * true if the user is a member of each of the passed groups
5410 * - array( APCOND_ISIP, ip ):
5411 * true if the user has the passed IP address
5412 * - array( APCOND_IPINRANGE, range ):
5413 * true if the user has an IP address in the range of the passed parameter
5414 * - array( APCOND_BLOCKED ):
5415 * true if the user is blocked
5416 * - array( APCOND_ISBOT ):
5417 * true if the user is a bot
5418 * - similar constructs can be defined by extensions
5420 * The sets of conditions are evaluated recursively, so you can use nested sets of conditions
5421 * linked by operands.
5423 * Note that if $wgEmailAuthentication is disabled, APCOND_EMAILCONFIRMED will be true for any
5424 * user who has provided an e-mail address.
5427 'autoconfirmed' => [ '&',
5428 [ APCOND_EDITCOUNT
, &$wgAutoConfirmCount ],
5429 [ APCOND_AGE
, &$wgAutoConfirmAge ],
5434 * Automatically add a usergroup to any user who matches certain conditions.
5436 * Does not add the user to the group again if it has been removed.
5437 * Also, does not remove the group if the user no longer meets the criteria.
5441 * [ event => criteria, ... ]
5443 * Where event is either:
5444 * - 'onEdit' (when user edits)
5446 * Criteria has the same format as $wgAutopromote
5448 * @see $wgAutopromote
5451 $wgAutopromoteOnce = [
5456 * Put user rights log entries for autopromotion in recent changes?
5459 $wgAutopromoteOnceLogInRC = true;
5462 * $wgAddGroups and $wgRemoveGroups can be used to give finer control over who
5463 * can assign which groups at Special:Userrights.
5466 * Bureaucrats can add any group:
5468 * $wgAddGroups['bureaucrat'] = true;
5470 * Bureaucrats can only remove bots and sysops:
5472 * $wgRemoveGroups['bureaucrat'] = [ 'bot', 'sysop' ];
5474 * Sysops can make bots:
5476 * $wgAddGroups['sysop'] = [ 'bot' ];
5478 * Sysops can disable other sysops in an emergency, and disable bots:
5480 * $wgRemoveGroups['sysop'] = [ 'sysop', 'bot' ];
5488 $wgRemoveGroups = [];
5491 * A list of available rights, in addition to the ones defined by the core.
5492 * For extensions only.
5494 $wgAvailableRights = [];
5497 * Optional to restrict deletion of pages with higher revision counts
5498 * to users with the 'bigdelete' permission. (Default given to sysops.)
5500 $wgDeleteRevisionsLimit = 0;
5503 * The maximum number of edits a user can have and
5504 * can still be hidden by users with the hideuser permission.
5505 * This is limited for performance reason.
5506 * Set to false to disable the limit.
5509 $wgHideUserContribLimit = 1000;
5512 * Number of accounts each IP address may create per specified period(s).
5516 * $wgAccountCreationThrottle = [
5517 * // no more than 100 per month
5520 * 'seconds' => 30*86400,
5522 * // no more than 10 per day
5525 * 'seconds' => 86400,
5530 * @warning Requires $wgMainCacheType to be enabled
5532 $wgAccountCreationThrottle = [ [
5538 * Edits matching these regular expressions in body text
5539 * will be recognised as spam and rejected automatically.
5541 * There's no administrator override on-wiki, so be careful what you set. :)
5542 * May be an array of regexes or a single string for backwards compatibility.
5544 * @see https://en.wikipedia.org/wiki/Regular_expression
5546 * @note Each regex needs a beginning/end delimiter, eg: # or /
5551 * Same as the above except for edit summaries
5553 $wgSummarySpamRegex = [];
5556 * Whether to use DNS blacklists in $wgDnsBlacklistUrls to check for open
5560 $wgEnableDnsBlacklist = false;
5563 * List of DNS blacklists to use, if $wgEnableDnsBlacklist is true.
5565 * This is an array of either a URL or an array with the URL and a key (should
5566 * the blacklist require a key).
5570 * $wgDnsBlacklistUrls = [
5571 * // String containing URL
5572 * 'http.dnsbl.sorbs.net.',
5573 * // Array with URL and key, for services that require a key
5574 * [ 'dnsbl.httpbl.net.', 'mykey' ],
5575 * // Array with just the URL. While this works, it is recommended that you
5576 * // just use a string as shown above
5577 * [ 'opm.tornevall.org.' ]
5581 * @note You should end the domain name with a . to avoid searching your
5582 * eventual domain search suffixes.
5585 $wgDnsBlacklistUrls = [ 'http.dnsbl.sorbs.net.' ];
5588 * Proxy whitelist, list of addresses that are assumed to be non-proxy despite
5589 * what the other methods might say.
5591 $wgProxyWhitelist = [];
5594 * IP ranges that should be considered soft-blocked (anon-only, account
5595 * creation allowed). The intent is to use this to prevent anonymous edits from
5596 * shared resources such as Wikimedia Labs.
5600 $wgSoftBlockRanges = [];
5603 * Whether to look at the X-Forwarded-For header's list of (potentially spoofed)
5604 * IPs and apply IP blocks to them. This allows for IP blocks to work with correctly-configured
5605 * (transparent) proxies without needing to block the proxies themselves.
5607 $wgApplyIpBlocksToXff = false;
5610 * Simple rate limiter options to brake edit floods.
5612 * Maximum number actions allowed in the given number of seconds; after that
5613 * the violating client receives HTTP 500 error pages until the period
5617 * Limits per configured per action and then type of users.
5621 * 'anon' => [ x, y ], // any and all anonymous edits (aggregate)
5622 * 'user' => [ x, y ], // each logged-in user
5623 * 'newbie' => [ x, y ], // each new autoconfirmed accounts; overrides 'user'
5624 * 'ip' => [ x, y ], // each anon and recent account
5625 * 'subnet' => [ x, y ], // ... within a /24 subnet in IPv4 or /64 in IPv6
5626 * 'groupName' => [ x, y ], // by group membership
5631 * @par Normally, the 'noratelimit' right allows a user to bypass any rate
5632 * limit checks. This can be disabled on a per-action basis by setting the
5633 * special '&can-bypass' key to false in that action's configuration.
5636 * 'some-action' => [
5637 * '&can-bypass' => false,
5638 * 'user' => [ x, y ],
5642 * @warning Requires that $wgMainCacheType is set to something persistent
5648 'newbie' => [ 8, 60 ],
5652 'newbie' => [ 2, 120 ],
5653 'user' => [ 8, 60 ],
5658 'newbie' => [ 8, 60 ],
5662 'user' => [ 10, 60 ],
5663 'newbie' => [ 5, 120 ]
5665 // Triggering password resets emails
5667 'ip' => [ 5, 3600 ],
5669 // Emailing other users using MediaWiki
5671 'ip' => [ 5, 86400 ],
5672 'newbie' => [ 5, 86400 ],
5673 'user' => [ 20, 86400 ],
5678 'user' => [ 30, 60 ],
5680 // Purges of link tables
5683 'user' => [ 30, 60 ],
5685 // Files rendered via thumb.php or thumb_handler.php
5687 'ip' => [ 700, 30 ],
5688 'user' => [ 700, 30 ],
5690 // Same as above but for non-standard thumbnails
5691 'renderfile-nonstandard' => [
5693 'user' => [ 70, 30 ],
5695 // Stashing edits into cache before save
5698 'newbie' => [ 30, 60 ],
5700 // Adding or removing change tags
5703 'newbie' => [ 8, 60 ],
5705 // Changing the content model of a page
5706 'editcontentmodel' => [
5707 'newbie' => [ 2, 120 ],
5708 'user' => [ 8, 60 ],
5713 * Array of IPs / CIDR ranges which should be excluded from rate limits.
5714 * This may be useful for whitelisting NAT gateways for conferences, etc.
5716 $wgRateLimitsExcludedIPs = [];
5719 * Log IP addresses in the recentchanges table; can be accessed only by
5720 * extensions (e.g. CheckUser) or a DB admin
5721 * Used for retroactive autoblocks
5723 $wgPutIPinRC = true;
5726 * Integer defining default number of entries to show on
5727 * special pages which are query-pages such as Special:Whatlinkshere.
5729 $wgQueryPageDefaultLimit = 50;
5732 * Limit password attempts to X attempts per Y seconds per IP per account.
5734 * Value is an array of arrays. Each sub-array must have a key for count
5735 * (ie count of how many attempts before throttle) and a key for seconds.
5736 * If the key 'allIPs' (case sensitive) is present, then the limit is
5737 * just per account instead of per IP per account.
5739 * @since 1.27 allIps support and multiple limits added in 1.27. Prior
5740 * to 1.27 this only supported having a single throttle.
5741 * @warning Requires $wgMainCacheType to be enabled
5743 $wgPasswordAttemptThrottle = [
5745 [ 'count' => 5, 'seconds' => 300 ],
5746 // Long term limit. We need to balance the risk
5747 // of somebody using this as a DoS attack to lock someone
5748 // out of their account, and someone doing a brute force attack.
5749 [ 'count' => 150, 'seconds' => 60*60*48 ],
5753 * @var Array Map of (grant => right => boolean)
5754 * Users authorize consumers (like Apps) to act on their behalf but only with
5755 * a subset of the user's normal account rights (signed off on by the user).
5756 * The possible rights to grant to a consumer are bundled into groups called
5757 * "grants". Each grant defines some rights it lets consumers inherit from the
5758 * account they may act on behalf of. Note that a user granting a right does
5759 * nothing if that user does not actually have that right to begin with.
5762 $wgGrantPermissions = [];
5764 // @TODO: clean up grants
5765 // @TODO: auto-include read/editsemiprotected rights?
5767 $wgGrantPermissions['basic']['autoconfirmed'] = true;
5768 $wgGrantPermissions['basic']['autopatrol'] = true;
5769 $wgGrantPermissions['basic']['editsemiprotected'] = true;
5770 $wgGrantPermissions['basic']['ipblock-exempt'] = true;
5771 $wgGrantPermissions['basic']['nominornewtalk'] = true;
5772 $wgGrantPermissions['basic']['patrolmarks'] = true;
5773 $wgGrantPermissions['basic']['purge'] = true;
5774 $wgGrantPermissions['basic']['read'] = true;
5775 $wgGrantPermissions['basic']['skipcaptcha'] = true;
5776 $wgGrantPermissions['basic']['writeapi'] = true;
5778 $wgGrantPermissions['highvolume']['bot'] = true;
5779 $wgGrantPermissions['highvolume']['apihighlimits'] = true;
5780 $wgGrantPermissions['highvolume']['noratelimit'] = true;
5781 $wgGrantPermissions['highvolume']['markbotedits'] = true;
5783 $wgGrantPermissions['editpage']['edit'] = true;
5784 $wgGrantPermissions['editpage']['minoredit'] = true;
5785 $wgGrantPermissions['editpage']['applychangetags'] = true;
5786 $wgGrantPermissions['editpage']['changetags'] = true;
5788 $wgGrantPermissions['editprotected'] = $wgGrantPermissions['editpage'];
5789 $wgGrantPermissions['editprotected']['editprotected'] = true;
5791 $wgGrantPermissions['editmycssjs'] = $wgGrantPermissions['editpage'];
5792 $wgGrantPermissions['editmycssjs']['editmyusercss'] = true;
5793 $wgGrantPermissions['editmycssjs']['editmyuserjs'] = true;
5795 $wgGrantPermissions['editmyoptions']['editmyoptions'] = true;
5797 $wgGrantPermissions['editinterface'] = $wgGrantPermissions['editpage'];
5798 $wgGrantPermissions['editinterface']['editinterface'] = true;
5799 $wgGrantPermissions['editinterface']['editusercss'] = true;
5800 $wgGrantPermissions['editinterface']['edituserjs'] = true;
5802 $wgGrantPermissions['createeditmovepage'] = $wgGrantPermissions['editpage'];
5803 $wgGrantPermissions['createeditmovepage']['createpage'] = true;
5804 $wgGrantPermissions['createeditmovepage']['createtalk'] = true;
5805 $wgGrantPermissions['createeditmovepage']['move'] = true;
5806 $wgGrantPermissions['createeditmovepage']['move-rootuserpages'] = true;
5807 $wgGrantPermissions['createeditmovepage']['move-subpages'] = true;
5808 $wgGrantPermissions['createeditmovepage']['move-categorypages'] = true;
5810 $wgGrantPermissions['uploadfile']['upload'] = true;
5811 $wgGrantPermissions['uploadfile']['reupload-own'] = true;
5813 $wgGrantPermissions['uploadeditmovefile'] = $wgGrantPermissions['uploadfile'];
5814 $wgGrantPermissions['uploadeditmovefile']['reupload'] = true;
5815 $wgGrantPermissions['uploadeditmovefile']['reupload-shared'] = true;
5816 $wgGrantPermissions['uploadeditmovefile']['upload_by_url'] = true;
5817 $wgGrantPermissions['uploadeditmovefile']['movefile'] = true;
5818 $wgGrantPermissions['uploadeditmovefile']['suppressredirect'] = true;
5820 $wgGrantPermissions['patrol']['patrol'] = true;
5822 $wgGrantPermissions['rollback']['rollback'] = true;
5824 $wgGrantPermissions['blockusers']['block'] = true;
5825 $wgGrantPermissions['blockusers']['blockemail'] = true;
5827 $wgGrantPermissions['viewdeleted']['browsearchive'] = true;
5828 $wgGrantPermissions['viewdeleted']['deletedhistory'] = true;
5829 $wgGrantPermissions['viewdeleted']['deletedtext'] = true;
5831 $wgGrantPermissions['viewrestrictedlogs']['suppressionlog'] = true;
5833 $wgGrantPermissions['delete'] = $wgGrantPermissions['editpage'] +
5834 $wgGrantPermissions['viewdeleted'];
5835 $wgGrantPermissions['delete']['delete'] = true;
5836 $wgGrantPermissions['delete']['bigdelete'] = true;
5837 $wgGrantPermissions['delete']['deletelogentry'] = true;
5838 $wgGrantPermissions['delete']['deleterevision'] = true;
5839 $wgGrantPermissions['delete']['undelete'] = true;
5841 $wgGrantPermissions['protect'] = $wgGrantPermissions['editprotected'];
5842 $wgGrantPermissions['protect']['protect'] = true;
5844 $wgGrantPermissions['viewmywatchlist']['viewmywatchlist'] = true;
5846 $wgGrantPermissions['editmywatchlist']['editmywatchlist'] = true;
5848 $wgGrantPermissions['sendemail']['sendemail'] = true;
5850 $wgGrantPermissions['createaccount']['createaccount'] = true;
5852 $wgGrantPermissions['privateinfo']['viewmyprivateinfo'] = true;
5855 * @var Array Map of grants to their UI grouping
5858 $wgGrantPermissionGroups = [
5859 // Hidden grants are implicitly present
5860 'basic' => 'hidden',
5862 'editpage' => 'page-interaction',
5863 'createeditmovepage' => 'page-interaction',
5864 'editprotected' => 'page-interaction',
5865 'patrol' => 'page-interaction',
5867 'uploadfile' => 'file-interaction',
5868 'uploadeditmovefile' => 'file-interaction',
5870 'sendemail' => 'email',
5872 'viewmywatchlist' => 'watchlist-interaction',
5873 'editviewmywatchlist' => 'watchlist-interaction',
5875 'editmycssjs' => 'customization',
5876 'editmyoptions' => 'customization',
5878 'editinterface' => 'administration',
5879 'rollback' => 'administration',
5880 'blockusers' => 'administration',
5881 'delete' => 'administration',
5882 'viewdeleted' => 'administration',
5883 'viewrestrictedlogs' => 'administration',
5884 'protect' => 'administration',
5885 'createaccount' => 'administration',
5887 'highvolume' => 'high-volume',
5889 'privateinfo' => 'private-information',
5893 * @var bool Whether to enable bot passwords
5896 $wgEnableBotPasswords = true;
5899 * Cluster for the bot_passwords table
5900 * @var string|bool If false, the normal cluster will be used
5903 $wgBotPasswordsCluster = false;
5906 * Database name for the bot_passwords table
5908 * To use a database with a table prefix, set this variable to
5909 * "{$database}-{$prefix}".
5910 * @var string|bool If false, the normal database will be used
5913 $wgBotPasswordsDatabase = false;
5915 /** @} */ # end of user rights settings
5917 /************************************************************************//**
5918 * @name Proxy scanner settings
5923 * This should always be customised in LocalSettings.php
5925 $wgSecretKey = false;
5928 * Big list of banned IP addresses.
5930 * This can have the following formats:
5931 * - An array of addresses, either in the values
5932 * or the keys (for backward compatibility, deprecated since 1.30)
5933 * - A string, in that case this is the path to a file
5934 * containing the list of IP addresses, one per line
5938 /** @} */ # end of proxy scanner settings
5940 /************************************************************************//**
5941 * @name Cookie settings
5946 * Default cookie lifetime, in seconds. Setting to 0 makes all cookies session-only.
5948 $wgCookieExpiration = 30 * 86400;
5951 * Default login cookie lifetime, in seconds. Setting
5952 * $wgExtendLoginCookieExpiration to null will use $wgCookieExpiration to
5953 * calculate the cookie lifetime. As with $wgCookieExpiration, 0 will make
5954 * login cookies session-only.
5956 $wgExtendedLoginCookieExpiration = 180 * 86400;
5959 * Set to set an explicit domain on the login cookies eg, "justthis.domain.org"
5960 * or ".any.subdomain.net"
5962 $wgCookieDomain = '';
5965 * Set this variable if you want to restrict cookies to a certain path within
5966 * the domain specified by $wgCookieDomain.
5968 $wgCookiePath = '/';
5971 * Whether the "secure" flag should be set on the cookie. This can be:
5972 * - true: Set secure flag
5973 * - false: Don't set secure flag
5974 * - "detect": Set the secure flag if $wgServer is set to an HTTPS URL
5976 $wgCookieSecure = 'detect';
5979 * By default, MediaWiki checks if the client supports cookies during the
5980 * login process, so that it can display an informative error message if
5981 * cookies are disabled. Set this to true if you want to disable this cookie
5984 $wgDisableCookieCheck = false;
5987 * Cookies generated by MediaWiki have names starting with this prefix. Set it
5988 * to a string to use a custom prefix. Setting it to false causes the database
5989 * name to be used as a prefix.
5991 $wgCookiePrefix = false;
5994 * Set authentication cookies to HttpOnly to prevent access by JavaScript,
5995 * in browsers that support this feature. This can mitigates some classes of
5998 $wgCookieHttpOnly = true;
6001 * A list of cookies that vary the cache (for use by extensions)
6003 $wgCacheVaryCookies = [];
6006 * Override to customise the session name
6008 $wgSessionName = false;
6011 * Whether to set a cookie when a user is autoblocked. Doing so means that a blocked user, even
6012 * after logging out and moving to a new IP address, will still be blocked. This cookie will contain
6013 * an authentication code if $wgSecretKey is set, or otherwise will just be the block ID (in
6014 * which case there is a possibility of an attacker discovering the names of revdeleted users, so
6015 * it is best to use this in conjunction with $wgSecretKey being set).
6017 $wgCookieSetOnAutoblock = false;
6019 /** @} */ # end of cookie settings }
6021 /************************************************************************//**
6022 * @name LaTeX (mathematical formulas)
6027 * To use inline TeX, you need to compile 'texvc' (in the 'math' subdirectory of
6028 * the MediaWiki package and have latex, dvips, gs (ghostscript), andconvert
6029 * (ImageMagick) installed and available in the PATH.
6030 * Please see math/README for more information.
6034 /** @} */ # end LaTeX }
6036 /************************************************************************//**
6037 * @name Profiling, testing and debugging
6039 * To enable profiling, edit StartProfiler.php
6045 * Filename for debug logging. See https://www.mediawiki.org/wiki/How_to_debug
6046 * The debug log file should be not be publicly accessible if it is used, as it
6047 * may contain private data.
6049 $wgDebugLogFile = '';
6052 * Prefix for debug log lines
6054 $wgDebugLogPrefix = '';
6057 * If true, instead of redirecting, show a page with a link to the redirect
6058 * destination. This allows for the inspection of PHP error messages, and easy
6059 * resubmission of form data. For developer use only.
6061 $wgDebugRedirects = false;
6064 * If true, log debugging data from action=raw and load.php.
6065 * This is normally false to avoid overlapping debug entries due to gen=css
6066 * and gen=js requests.
6068 $wgDebugRawPage = false;
6071 * Send debug data to an HTML comment in the output.
6073 * This may occasionally be useful when supporting a non-technical end-user.
6074 * It's more secure than exposing the debug log file to the web, since the
6075 * output only contains private data for the current user. But it's not ideal
6076 * for development use since data is lost on fatal errors and redirects.
6078 $wgDebugComments = false;
6081 * Write SQL queries to the debug log.
6083 * This setting is only used $wgLBFactoryConf['class'] is set to
6084 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
6085 * the DBO_DEBUG flag must be set in the 'flags' option of the database
6086 * connection to achieve the same functionality.
6088 $wgDebugDumpSql = false;
6091 * Performance expectations for DB usage
6095 $wgTrxProfilerLimits = [
6096 // HTTP GET/HEAD requests.
6097 // Master queries should not happen on GET requests
6101 'readQueryTime' => 5
6103 // HTTP POST requests.
6104 // Master reads and writes will happen for a subset of these.
6106 'readQueryTime' => 5,
6107 'writeQueryTime' => 1,
6108 'maxAffected' => 1000
6110 'POST-nonwrite' => [
6113 'readQueryTime' => 5
6115 // Deferred updates that run after HTTP response is sent
6117 'readQueryTime' => 5,
6118 'writeQueryTime' => 1,
6119 'maxAffected' => 1000
6121 // Background job runner
6123 'readQueryTime' => 30,
6124 'writeQueryTime' => 5,
6125 'maxAffected' => 500 // ballpark of $wgUpdateRowsPerQuery
6127 // Command-line scripts
6129 'writeQueryTime' => 5,
6130 'maxAffected' => 1000
6135 * Map of string log group names to log destinations.
6137 * If set, wfDebugLog() output for that group will go to that file instead
6138 * of the regular $wgDebugLogFile. Useful for enabling selective logging
6141 * Log destinations may be one of the following:
6142 * - false to completely remove from the output, including from $wgDebugLogFile.
6143 * - string values specifying a filename or URI.
6144 * - associative array with keys:
6145 * - 'destination' desired filename or URI.
6146 * - 'sample' an integer value, specifying a sampling factor (optional)
6147 * - 'level' A \Psr\Log\LogLevel constant, indicating the minimum level
6148 * to log (optional, since 1.25)
6152 * $wgDebugLogGroups['redis'] = '/var/log/mediawiki/redis.log';
6155 * @par Advanced example:
6157 * $wgDebugLogGroups['memcached'] = [
6158 * 'destination' => '/var/log/mediawiki/memcached.log',
6159 * 'sample' => 1000, // log 1 message out of every 1,000.
6160 * 'level' => \Psr\Log\LogLevel::WARNING
6164 $wgDebugLogGroups = [];
6167 * Default service provider for creating Psr\Log\LoggerInterface instances.
6169 * The value should be an array suitable for use with
6170 * ObjectFactory::getObjectFromSpec(). The created object is expected to
6171 * implement the MediaWiki\Logger\Spi interface. See ObjectFactory for additional
6174 * Alternately the MediaWiki\Logger\LoggerFactory::registerProvider method can
6175 * be called to inject an MediaWiki\Logger\Spi instance into the LoggerFactory
6176 * and bypass the use of this configuration variable entirely.
6178 * @par To completely disable logging:
6180 * $wgMWLoggerDefaultSpi = [ 'class' => '\\MediaWiki\\Logger\\NullSpi' ];
6184 * @var array $wgMWLoggerDefaultSpi
6187 $wgMWLoggerDefaultSpi = [
6188 'class' => '\\MediaWiki\\Logger\\LegacySpi',
6192 * Display debug data at the bottom of the main content area.
6194 * Useful for developers and technical users trying to working on a closed wiki.
6196 $wgShowDebug = false;
6199 * Prefix debug messages with relative timestamp. Very-poor man's profiler.
6200 * Since 1.19 also includes memory usage.
6202 $wgDebugTimestamps = false;
6205 * Print HTTP headers for every request in the debug information.
6207 $wgDebugPrintHttpHeaders = true;
6210 * Show the contents of $wgHooks in Special:Version
6212 $wgSpecialVersionShowHooks = false;
6215 * Whether to show "we're sorry, but there has been a database error" pages.
6216 * Displaying errors aids in debugging, but may display information useful
6219 $wgShowSQLErrors = false;
6222 * If set to true, uncaught exceptions will print a complete stack trace
6223 * to output. This should only be used for debugging, as it may reveal
6224 * private information in function parameters due to PHP's backtrace
6227 $wgShowExceptionDetails = false;
6230 * If true, show a backtrace for database errors
6232 * @note This setting only applies when connection errors and query errors are
6233 * reported in the normal manner. $wgShowExceptionDetails applies in other cases,
6234 * including those in which an uncaught exception is thrown from within the
6235 * exception handler.
6237 $wgShowDBErrorBacktrace = false;
6240 * If true, send the exception backtrace to the error log
6242 $wgLogExceptionBacktrace = true;
6245 * Expose backend server host names through the API and various HTML comments
6247 $wgShowHostnames = false;
6250 * Override server hostname detection with a hardcoded value.
6251 * Should be a string, default false.
6254 $wgOverrideHostname = false;
6257 * If set to true MediaWiki will throw notices for some possible error
6258 * conditions and for deprecated functions.
6260 $wgDevelopmentWarnings = false;
6263 * Release limitation to wfDeprecated warnings, if set to a release number
6264 * development warnings will not be generated for deprecations added in releases
6267 $wgDeprecationReleaseLimit = false;
6270 * Only record profiling info for pages that took longer than this
6271 * @deprecated since 1.25: set $wgProfiler['threshold'] instead.
6273 $wgProfileLimit = 0.0;
6276 * Don't put non-profiling info into log file
6278 * @deprecated since 1.23, set the log file in
6279 * $wgDebugLogGroups['profileoutput'] instead.
6281 $wgProfileOnly = false;
6284 * Destination of statsd metrics.
6286 * A host or host:port of a statsd server. Port defaults to 8125.
6288 * If not set, statsd metrics will not be collected.
6290 * @see wfLogProfilingData
6293 $wgStatsdServer = false;
6296 * Prefix for metric names sent to $wgStatsdServer.
6298 * @see MediaWikiServices::getStatsdDataFactory
6299 * @see BufferingStatsdDataFactory
6302 $wgStatsdMetricPrefix = 'MediaWiki';
6305 * Sampling rate for statsd metrics as an associative array of patterns and rates.
6306 * Patterns are Unix shell patterns (e.g. 'MediaWiki.api.*').
6307 * Rates are sampling probabilities (e.g. 0.1 means 1 in 10 events are sampled).
6310 $wgStatsdSamplingRates = [];
6313 * InfoAction retrieves a list of transclusion links (both to and from).
6314 * This number puts a limit on that query in the case of highly transcluded
6317 $wgPageInfoTransclusionLimit = 50;
6320 * Set this to an integer to only do synchronous site_stats updates
6321 * one every *this many* updates. The other requests go into pending
6322 * delta values in $wgMemc. Make sure that $wgMemc is a global cache.
6323 * If set to -1, updates *only* go to $wgMemc (useful for daemons).
6325 $wgSiteStatsAsyncFactor = false;
6328 * Parser test suite files to be run by parserTests.php when no specific
6329 * filename is passed to it.
6331 * Extensions may add their own tests to this array, or site-local tests
6332 * may be added via LocalSettings.php
6336 $wgParserTestFiles = [
6337 "$IP/tests/parser/parserTests.txt",
6338 "$IP/tests/parser/extraParserTests.txt"
6342 * Allow running of javascript test suites via [[Special:JavaScriptTest]] (such as QUnit).
6344 $wgEnableJavaScriptTest = false;
6347 * Overwrite the caching key prefix with custom value.
6350 $wgCachePrefix = false;
6353 * Display the new debugging toolbar. This also enables profiling on database
6354 * queries and other useful output.
6355 * Will be ignored if $wgUseFileCache or $wgUseSquid is enabled.
6359 $wgDebugToolbar = false;
6361 /** @} */ # end of profiling, testing and debugging }
6363 /************************************************************************//**
6369 * Set this to true to disable the full text search feature.
6371 $wgDisableTextSearch = false;
6374 * Set to true to have nicer highlighted text in search results,
6375 * by default off due to execution overhead
6377 $wgAdvancedSearchHighlighting = false;
6380 * Regexp to match word boundaries, defaults for non-CJK languages
6381 * should be empty for CJK since the words are not separate
6383 $wgSearchHighlightBoundaries = '[\p{Z}\p{P}\p{C}]';
6386 * Template for OpenSearch suggestions, defaults to API action=opensearch
6388 * Sites with heavy load would typically have these point to a custom
6389 * PHP wrapper to avoid firing up mediawiki for every keystroke
6391 * Placeholders: {searchTerms}
6393 * @deprecated since 1.25 Use $wgOpenSearchTemplates['application/x-suggestions+json'] instead
6395 $wgOpenSearchTemplate = false;
6398 * Templates for OpenSearch suggestions, defaults to API action=opensearch
6400 * Sites with heavy load would typically have these point to a custom
6401 * PHP wrapper to avoid firing up mediawiki for every keystroke
6403 * Placeholders: {searchTerms}
6405 $wgOpenSearchTemplates = [
6406 'application/x-suggestions+json' => false,
6407 'application/x-suggestions+xml' => false,
6411 * Enable OpenSearch suggestions requested by MediaWiki. Set this to
6412 * false if you've disabled scripts that use api?action=opensearch and
6413 * want reduce load caused by cached scripts still pulling suggestions.
6414 * It will let the API fallback by responding with an empty array.
6416 $wgEnableOpenSearchSuggest = true;
6419 * Integer defining default number of entries to show on
6422 $wgOpenSearchDefaultLimit = 10;
6425 * Minimum length of extract in <Description>. Actual extracts will last until the end of sentence.
6427 $wgOpenSearchDescriptionLength = 100;
6430 * Expiry time for search suggestion responses
6432 $wgSearchSuggestCacheExpiry = 1200;
6435 * If you've disabled search semi-permanently, this also disables updates to the
6436 * table. If you ever re-enable, be sure to rebuild the search table.
6438 $wgDisableSearchUpdate = false;
6441 * List of namespaces which are searched by default.
6445 * $wgNamespacesToBeSearchedDefault[NS_MAIN] = true;
6446 * $wgNamespacesToBeSearchedDefault[NS_PROJECT] = true;
6449 $wgNamespacesToBeSearchedDefault = [
6454 * Disable the internal MySQL-based search, to allow it to be
6455 * implemented by an extension instead.
6457 $wgDisableInternalSearch = false;
6460 * Set this to a URL to forward search requests to some external location.
6461 * If the URL includes '$1', this will be replaced with the URL-encoded
6465 * To forward to Google you'd have something like:
6467 * $wgSearchForwardUrl =
6468 * 'https://www.google.com/search?q=$1' .
6469 * '&domains=https://example.com' .
6470 * '&sitesearch=https://example.com' .
6471 * '&ie=utf-8&oe=utf-8';
6474 $wgSearchForwardUrl = null;
6477 * Search form behavior.
6478 * - true = use Go & Search buttons
6479 * - false = use Go button & Advanced search link
6481 $wgUseTwoButtonsSearchForm = true;
6484 * Array of namespaces to generate a Google sitemap for when the
6485 * maintenance/generateSitemap.php script is run, or false if one is to be
6486 * generated for all namespaces.
6488 $wgSitemapNamespaces = false;
6491 * Custom namespace priorities for sitemaps. Setting this will allow you to
6492 * set custom priorities to namespaces when sitemaps are generated using the
6493 * maintenance/generateSitemap.php script.
6495 * This should be a map of namespace IDs to priority
6498 * $wgSitemapNamespacesPriorities = [
6504 $wgSitemapNamespacesPriorities = false;
6507 * If true, searches for IP addresses will be redirected to that IP's
6508 * contributions page. E.g. searching for "1.2.3.4" will redirect to
6509 * [[Special:Contributions/1.2.3.4]]
6511 $wgEnableSearchContributorsByIP = true;
6513 /** @} */ # end of search settings
6515 /************************************************************************//**
6516 * @name Edit user interface
6521 * Path to the GNU diff3 utility. If the file doesn't exist, edit conflicts will
6522 * fall back to the old behavior (no merging).
6524 $wgDiff3 = '/usr/bin/diff3';
6527 * Path to the GNU diff utility.
6529 $wgDiff = '/usr/bin/diff';
6532 * Which namespaces have special treatment where they should be preview-on-open
6533 * Internally only Category: pages apply, but using this extensions (e.g. Semantic MediaWiki)
6534 * can specify namespaces of pages they have special treatment for
6536 $wgPreviewOnOpenNamespaces = [
6541 * Enable the UniversalEditButton for browsers that support it
6542 * (currently only Firefox with an extension)
6543 * See http://universaleditbutton.org for more background information
6545 $wgUniversalEditButton = true;
6548 * If user doesn't specify any edit summary when making a an edit, MediaWiki
6549 * will try to automatically create one. This feature can be disabled by set-
6550 * ting this variable false.
6552 $wgUseAutomaticEditSummaries = true;
6554 /** @} */ # end edit UI }
6556 /************************************************************************//**
6558 * See also $wgSiteNotice
6563 * @cond file_level_code
6564 * Set $wgCommandLineMode if it's not set already, to avoid notices
6566 if ( !isset( $wgCommandLineMode ) ) {
6567 $wgCommandLineMode = false;
6572 * For colorized maintenance script output, is your terminal background dark ?
6574 $wgCommandLineDarkBg = false;
6577 * Set this to a string to put the wiki into read-only mode. The text will be
6578 * used as an explanation to users.
6580 * This prevents most write operations via the web interface. Cache updates may
6581 * still be possible. To prevent database writes completely, use the read_only
6587 * If this lock file exists (size > 0), the wiki will be forced into read-only mode.
6588 * Its contents will be shown to users as part of the read-only warning
6591 * Will default to "{$wgUploadDirectory}/lock_yBgMBwiR" in Setup.php
6593 $wgReadOnlyFile = false;
6596 * When you run the web-based upgrade utility, it will tell you what to set
6597 * this to in order to authorize the upgrade process. It will subsequently be
6598 * used as a password, to authorize further upgrades.
6600 * For security, do not set this to a guessable string. Use the value supplied
6601 * by the install/upgrade process. To cause the upgrader to generate a new key,
6602 * delete the old key from LocalSettings.php.
6604 $wgUpgradeKey = false;
6607 * Fully specified path to git binary
6609 $wgGitBin = '/usr/bin/git';
6612 * Map GIT repository URLs to viewer URLs to provide links in Special:Version
6614 * Key is a pattern passed to preg_match() and preg_replace(),
6615 * without the delimiters (which are #) and must match the whole URL.
6616 * The value is the replacement for the key (it can contain $1, etc.)
6617 * %h will be replaced by the short SHA-1 (7 first chars) and %H by the
6618 * full SHA-1 of the HEAD revision.
6619 * %r will be replaced with a URL-encoded version of $1.
6620 * %R will be replaced with $1 and no URL-encoding
6624 $wgGitRepositoryViewers = [
6625 'https://(?:[a-z0-9_]+@)?gerrit.wikimedia.org/r/(?:p/)?(.*)' =>
6626 'https://phabricator.wikimedia.org/r/revision/%R;%H',
6627 'ssh://(?:[a-z0-9_]+@)?gerrit.wikimedia.org:29418/(.*)' =>
6628 'https://phabricator.wikimedia.org/r/revision/%R;%H',
6631 /** @} */ # End of maintenance }
6633 /************************************************************************//**
6634 * @name Recent changes, new pages, watchlist and history
6639 * Recentchanges items are periodically purged; entries older than this many
6641 * Default: 90 days = about three months
6643 $wgRCMaxAge = 90 * 24 * 3600;
6646 * Page watchers inactive for more than this many seconds are considered inactive.
6647 * Used mainly by action=info. Default: 180 days = about six months.
6650 $wgWatchersMaxAge = 180 * 24 * 3600;
6653 * If active watchers (per above) are this number or less, do not disclose it.
6654 * Left to 1, prevents unprivileged users from knowing for sure that there are 0.
6655 * Set to -1 if you want to always complement watchers count with this info.
6658 $wgUnwatchedPageSecret = 1;
6661 * Filter $wgRCLinkDays by $wgRCMaxAge to avoid showing links for numbers
6662 * higher than what will be stored. Note that this is disabled by default
6663 * because we sometimes do have RC data which is beyond the limit for some
6664 * reason, and some users may use the high numbers to display that data which
6667 $wgRCFilterByAge = false;
6670 * List of Limits options to list in the Special:Recentchanges and
6671 * Special:Recentchangeslinked pages.
6673 $wgRCLinkLimits = [ 50, 100, 250, 500 ];
6676 * List of Days options to list in the Special:Recentchanges and
6677 * Special:Recentchangeslinked pages.
6679 $wgRCLinkDays = [ 1, 3, 7, 14, 30 ];
6682 * Configuration for feeds to which notifications about recent changes will be sent.
6684 * The following feed classes are available by default:
6685 * - 'UDPRCFeedEngine' - sends recent changes over UDP to the specified server.
6686 * - 'RedisPubSubFeedEngine' - send recent changes to Redis.
6688 * Only 'class' or 'uri' is required. If 'uri' is set instead of 'class', then
6689 * RecentChange::getEngine() is used to determine the class. All options are
6690 * passed to the constructor.
6693 * - 'class' -- The class to use for this feed (must implement RCFeed).
6694 * - 'omit_bots' -- Exclude bot edits from the feed. (default: false)
6695 * - 'omit_anon' -- Exclude anonymous edits from the feed. (default: false)
6696 * - 'omit_user' -- Exclude edits by registered users from the feed. (default: false)
6697 * - 'omit_minor' -- Exclude minor edits from the feed. (default: false)
6698 * - 'omit_patrolled' -- Exclude patrolled edits from the feed. (default: false)
6700 * FormattedRCFeed-specific options:
6701 * - 'uri' -- [required] The address to which the messages are sent.
6702 * The uri scheme of this string will be looked up in $wgRCEngines
6703 * to determine which RCFeedEngine class to use.
6704 * - 'formatter' -- [required] The class (implementing RCFeedFormatter) which will
6705 * produce the text to send. This can also be an object of the class.
6706 * Formatters available by default: JSONRCFeedFormatter, XMLRCFeedFormatter,
6707 * IRCColourfulRCFeedFormatter.
6709 * IRCColourfulRCFeedFormatter-specific options:
6710 * - 'add_interwiki_prefix' -- whether the titles should be prefixed with
6711 * the first entry in the $wgLocalInterwikis array (or the value of
6712 * $wgLocalInterwiki, if set)
6714 * JSONRCFeedFormatter-specific options:
6715 * - 'channel' -- if set, the 'channel' parameter is also set in JSON values.
6717 * @example $wgRCFeeds['example'] = [
6718 * 'uri' => 'udp://localhost:1336',
6719 * 'formatter' => 'JSONRCFeedFormatter',
6720 * 'add_interwiki_prefix' => false,
6721 * 'omit_bots' => true,
6723 * @example $wgRCFeeds['example'] = [
6724 * 'uri' => 'udp://localhost:1338',
6725 * 'formatter' => 'IRCColourfulRCFeedFormatter',
6726 * 'add_interwiki_prefix' => false,
6727 * 'omit_bots' => true,
6729 * @example $wgRCFeeds['example'] = [
6730 * 'class' => 'ExampleRCFeed',
6737 * Used by RecentChange::getEngine to find the correct engine for a given URI scheme.
6738 * Keys are scheme names, values are names of FormattedRCFeed sub classes.
6742 'redis' => 'RedisPubSubFeedEngine',
6743 'udp' => 'UDPRCFeedEngine',
6747 * Treat category membership changes as a RecentChange.
6748 * Changes are mentioned in RC for page actions as follows:
6749 * - creation: pages created with categories are mentioned
6750 * - edit: category additions/removals to existing pages are mentioned
6751 * - move: nothing is mentioned (unless templates used depend on the title)
6752 * - deletion: nothing is mentioned
6753 * - undeletion: nothing is mentioned
6757 $wgRCWatchCategoryMembership = false;
6760 * Use RC Patrolling to check for vandalism (from recent changes and watchlists)
6761 * New pages and new files are included.
6763 $wgUseRCPatrol = true;
6766 * Whether to allow users to save their RecentChanges filters
6768 $wgStructuredChangeFiltersEnableSaving = true;
6771 * Whether to show the new experimental views (like namespaces, tags, and users) in
6772 * RecentChanges filters
6774 $wgStructuredChangeFiltersEnableExperimentalViews = false;
6777 * Use new page patrolling to check new pages on Special:Newpages
6779 $wgUseNPPatrol = true;
6782 * Use file patrolling to check new files on Special:Newfiles
6786 $wgUseFilePatrol = true;
6789 * Log autopatrol actions to the log table
6791 $wgLogAutopatrol = true;
6794 * Provide syndication feeds (RSS, Atom) for, e.g., Recentchanges, Newpages
6799 * Set maximum number of results to return in syndication feeds (RSS, Atom) for
6800 * eg Recentchanges, Newpages.
6805 * _Minimum_ timeout for cached Recentchanges feed, in seconds.
6806 * A cached version will continue to be served out even if changes
6807 * are made, until this many seconds runs out since the last render.
6809 * If set to 0, feed caching is disabled. Use this for debugging only;
6810 * feed generation can be pretty slow with diffs.
6812 $wgFeedCacheTimeout = 60;
6815 * When generating Recentchanges RSS/Atom feed, diffs will not be generated for
6816 * pages larger than this size.
6818 $wgFeedDiffCutoff = 32768;
6821 * Override the site's default RSS/ATOM feed for recentchanges that appears on
6822 * every page. Some sites might have a different feed they'd like to promote
6823 * instead of the RC feed (maybe like a "Recent New Articles" or "Breaking news" one).
6824 * Should be a format as key (either 'rss' or 'atom') and an URL to the feed
6827 * Configure the 'atom' feed to https://example.com/somefeed.xml
6829 * $wgSiteFeed['atom'] = "https://example.com/somefeed.xml";
6832 $wgOverrideSiteFeed = [];
6835 * Available feeds objects.
6836 * Should probably only be defined when a page is syndicated ie when
6837 * $wgOut->isSyndicated() is true.
6841 'atom' => 'AtomFeed',
6845 * Which feed types should we provide by default? This can include 'rss',
6846 * 'atom', neither, or both.
6848 $wgAdvertisedFeedTypes = [ 'atom' ];
6851 * Show watching users in recent changes, watchlist and page history views
6853 $wgRCShowWatchingUsers = false; # UPO
6856 * Show the amount of changed characters in recent changes
6858 $wgRCShowChangedSize = true;
6861 * If the difference between the character counts of the text
6862 * before and after the edit is below that value, the value will be
6863 * highlighted on the RC page.
6865 $wgRCChangedSizeThreshold = 500;
6868 * Show "Updated (since my last visit)" marker in RC view, watchlist and history
6869 * view for watched pages with new changes
6871 $wgShowUpdatedMarker = true;
6874 * Disable links to talk pages of anonymous users (IPs) in listings on special
6875 * pages like page history, Special:Recentchanges, etc.
6877 $wgDisableAnonTalk = false;
6880 * Enable filtering of categories in Recentchanges
6882 $wgAllowCategorizedRecentChanges = false;
6885 * Allow filtering by change tag in recentchanges, history, etc
6886 * Has no effect if no tags are defined in valid_tag.
6888 $wgUseTagFilter = true;
6891 * If set to an integer, pages that are watched by this many users or more
6892 * will not require the unwatchedpages permission to view the number of
6897 $wgUnwatchedPageThreshold = false;
6900 * Flags (letter symbols) shown in recent changes and watchlist to indicate
6901 * certain types of edits.
6903 * To register a new one:
6905 * $wgRecentChangesFlags['flag'] => [
6906 * // message for the letter displayed next to rows on changes lists
6907 * 'letter' => 'letter-msg',
6908 * // message for the tooltip of the letter
6909 * 'title' => 'tooltip-msg',
6910 * // optional (defaults to 'tooltip-msg'), message to use in the legend box
6911 * 'legend' => 'legend-msg',
6912 * // optional (defaults to 'flag'), CSS class to put on changes lists rows
6913 * 'class' => 'css-class',
6914 * // optional (defaults to 'any'), how top-level flag is determined. 'any'
6915 * // will set the top-level flag if any line contains the flag, 'all' will
6916 * // only be set if all lines contain the flag.
6917 * 'grouping' => 'any',
6923 $wgRecentChangesFlags = [
6925 'letter' => 'newpageletter',
6926 'title' => 'recentchanges-label-newpage',
6927 'legend' => 'recentchanges-legend-newpage',
6928 'grouping' => 'any',
6931 'letter' => 'minoreditletter',
6932 'title' => 'recentchanges-label-minor',
6933 'legend' => 'recentchanges-legend-minor',
6934 'class' => 'minoredit',
6935 'grouping' => 'all',
6938 'letter' => 'boteditletter',
6939 'title' => 'recentchanges-label-bot',
6940 'legend' => 'recentchanges-legend-bot',
6941 'class' => 'botedit',
6942 'grouping' => 'all',
6945 'letter' => 'unpatrolledletter',
6946 'title' => 'recentchanges-label-unpatrolled',
6947 'legend' => 'recentchanges-legend-unpatrolled',
6948 'grouping' => 'any',
6952 /** @} */ # end RC/watchlist }
6954 /************************************************************************//**
6955 * @name Copyright and credits settings
6960 * Override for copyright metadata.
6962 * This is the name of the page containing information about the wiki's copyright status,
6963 * which will be added as a link in the footer if it is specified. It overrides
6964 * $wgRightsUrl if both are specified.
6966 $wgRightsPage = null;
6969 * Set this to specify an external URL containing details about the content license used on your
6971 * If $wgRightsPage is set then this setting is ignored.
6973 $wgRightsUrl = null;
6976 * If either $wgRightsUrl or $wgRightsPage is specified then this variable gives the text for the
6978 * If using $wgRightsUrl then this value must be specified. If using $wgRightsPage then the name
6979 * of the page will also be used as the link if this variable is not set.
6981 $wgRightsText = null;
6984 * Override for copyright metadata.
6986 $wgRightsIcon = null;
6989 * Set this to true if you want detailed copyright information forms on Upload.
6991 $wgUseCopyrightUpload = false;
6994 * Set this to the number of authors that you want to be credited below an
6995 * article text. Set it to zero to hide the attribution block, and a negative
6996 * number (like -1) to show all authors. Note that this will require 2-3 extra
6997 * database hits, which can have a not insignificant impact on performance for
7003 * If there are more than $wgMaxCredits authors, show $wgMaxCredits of them.
7004 * Otherwise, link to a separate credits page.
7006 $wgShowCreditsIfMax = true;
7008 /** @} */ # end of copyright and credits settings }
7010 /************************************************************************//**
7011 * @name Import / Export
7016 * List of interwiki prefixes for wikis we'll accept as sources for
7017 * Special:Import and API action=import. Since complete page history can be
7018 * imported, these should be 'trusted'.
7020 * This can either be a regular array, or an associative map specifying
7021 * subprojects on the interwiki map of the target wiki, or a mix of the two,
7024 * $wgImportSources = [
7025 * 'wikipedia' => [ 'cs', 'en', 'fr', 'zh' ],
7027 * 'wikia' => [ 'animanga', 'brickipedia', 'desserts' ],
7031 * If you have a very complex import sources setup, you can lazy-load it using
7032 * the ImportSources hook.
7034 * If a user has the 'import' permission but not the 'importupload' permission,
7035 * they will only be able to run imports through this transwiki interface.
7037 $wgImportSources = [];
7040 * Optional default target namespace for interwiki imports.
7041 * Can use this to create an incoming "transwiki"-style queue.
7042 * Set to numeric key, not the name.
7044 * Users may override this in the Special:Import dialog.
7046 $wgImportTargetNamespace = null;
7049 * If set to false, disables the full-history option on Special:Export.
7050 * This is currently poorly optimized for long edit histories, so is
7051 * disabled on Wikimedia's sites.
7053 $wgExportAllowHistory = true;
7056 * If set nonzero, Special:Export requests for history of pages with
7057 * more revisions than this will be rejected. On some big sites things
7058 * could get bogged down by very very long pages.
7060 $wgExportMaxHistory = 0;
7063 * Return distinct author list (when not returning full history)
7065 $wgExportAllowListContributors = false;
7068 * If non-zero, Special:Export accepts a "pagelink-depth" parameter
7069 * up to this specified level, which will cause it to include all
7070 * pages linked to from the pages you specify. Since this number
7071 * can become *insanely large* and could easily break your wiki,
7072 * it's disabled by default for now.
7074 * @warning There's a HARD CODED limit of 5 levels of recursion to prevent a
7075 * crazy-big export from being done by someone setting the depth number too
7076 * high. In other words, last resort safety net.
7078 $wgExportMaxLinkDepth = 0;
7081 * Whether to allow the "export all pages in namespace" option
7083 $wgExportFromNamespaces = false;
7086 * Whether to allow exporting the entire wiki into a single file
7088 $wgExportAllowAll = false;
7091 * Maximum number of pages returned by the GetPagesFromCategory and
7092 * GetPagesFromNamespace functions.
7096 $wgExportPagelistLimit = 5000;
7098 /** @} */ # end of import/export }
7100 /*************************************************************************//**
7106 * A list of callback functions which are called once MediaWiki is fully
7109 $wgExtensionFunctions = [];
7112 * Extension messages files.
7114 * Associative array mapping extension name to the filename where messages can be
7115 * found. The file should contain variable assignments. Any of the variables
7116 * present in languages/messages/MessagesEn.php may be defined, but $messages
7117 * is the most common.
7119 * Variables defined in extensions will override conflicting variables defined
7122 * Since MediaWiki 1.23, use of this variable to define messages is discouraged; instead, store
7123 * messages in JSON format and use $wgMessagesDirs. For setting other variables than
7124 * $messages, $wgExtensionMessagesFiles should still be used. Use a DIFFERENT key because
7125 * any entry having a key that also exists in $wgMessagesDirs will be ignored.
7127 * Extensions using the JSON message format can preserve backward compatibility with
7128 * earlier versions of MediaWiki by using a compatibility shim, such as one generated
7129 * by the generateJsonI18n.php maintenance script, listing it under the SAME key
7130 * as for the $wgMessagesDirs entry.
7134 * $wgExtensionMessagesFiles['ConfirmEdit'] = __DIR__.'/ConfirmEdit.i18n.php';
7137 $wgExtensionMessagesFiles = [];
7140 * Extension messages directories.
7142 * Associative array mapping extension name to the path of the directory where message files can
7143 * be found. The message files are expected to be JSON files named for their language code, e.g.
7144 * en.json, de.json, etc. Extensions with messages in multiple places may specify an array of
7145 * message directories.
7147 * Message directories in core should be added to LocalisationCache::getMessagesDirs()
7149 * @par Simple example:
7151 * $wgMessagesDirs['Example'] = __DIR__ . '/i18n';
7154 * @par Complex example:
7156 * $wgMessagesDirs['Example'] = [
7157 * __DIR__ . '/lib/ve/i18n',
7158 * __DIR__ . '/lib/oojs-ui/i18n',
7159 * __DIR__ . '/i18n',
7164 $wgMessagesDirs = [];
7167 * Array of files with list(s) of extension entry points to be used in
7168 * maintenance/mergeMessageFileList.php
7171 $wgExtensionEntryPointListFiles = [];
7174 * Parser output hooks.
7175 * This is an associative array where the key is an extension-defined tag
7176 * (typically the extension name), and the value is a PHP callback.
7177 * These will be called as an OutputPageParserOutput hook, if the relevant
7178 * tag has been registered with the parser output object.
7180 * Registration is done with $pout->addOutputHook( $tag, $data ).
7182 * The callback has the form:
7184 * function outputHook( $outputPage, $parserOutput, $data ) { ... }
7187 $wgParserOutputHooks = [];
7190 * Whether to include the NewPP limit report as a HTML comment
7192 $wgEnableParserLimitReporting = true;
7195 * List of valid skin names
7197 * The key should be the name in all lower case, the value should be a properly
7198 * cased name for the skin. This value will be prefixed with "Skin" to create
7199 * the class name of the skin to load. Use Skin::getSkinNames() as an accessor
7200 * if you wish to have access to the full list.
7202 $wgValidSkinNames = [];
7205 * Special page list. This is an associative array mapping the (canonical) names of
7206 * special pages to either a class name to be instantiated, or a callback to use for
7207 * creating the special page object. In both cases, the result must be an instance of
7210 $wgSpecialPages = [];
7213 * Array mapping class names to filenames, for autoloading.
7215 $wgAutoloadClasses = [];
7218 * Switch controlling legacy case-insensitive classloading.
7219 * Do not disable if your wiki must support data created by PHP4, or by
7220 * MediaWiki 1.4 or earlier.
7222 $wgAutoloadAttemptLowercase = true;
7225 * An array of information about installed extensions keyed by their type.
7227 * All but 'name', 'path' and 'author' can be omitted.
7230 * $wgExtensionCredits[$type][] = [
7231 * 'path' => __FILE__,
7232 * 'name' => 'Example extension',
7233 * 'namemsg' => 'exampleextension-name',
7237 * 'version' => '1.9.0',
7238 * 'url' => 'https://example.org/example-extension/',
7239 * 'descriptionmsg' => 'exampleextension-desc',
7240 * 'license-name' => 'GPL-2.0+',
7244 * The extensions are listed on Special:Version. This page also looks for a file
7245 * named COPYING or LICENSE (optional .txt extension) and provides a link to
7246 * view said file. When the 'license-name' key is specified, this file is
7247 * interpreted as wikitext.
7249 * - $type: One of 'specialpage', 'parserhook', 'variable', 'media', 'antispam',
7250 * 'skin', 'api', or 'other', or any additional types as specified through the
7251 * ExtensionTypes hook as used in SpecialVersion::getExtensionTypes().
7253 * - name: Name of extension as an inline string instead of localizable message.
7254 * Do not omit this even if 'namemsg' is provided, as it is used to override
7255 * the path Special:Version uses to find extension's license info, and is
7256 * required for backwards-compatibility with MediaWiki 1.23 and older.
7258 * - namemsg (since MW 1.24): A message key for a message containing the
7259 * extension's name, if the name is localizable. (For example, skin names
7262 * - author: A string or an array of strings. Authors can be linked using
7263 * the regular wikitext link syntax. To have an internationalized version of
7264 * "and others" show, add an element "...". This element can also be linked,
7265 * for instance "[https://example ...]".
7267 * - descriptionmsg: A message key or an an array with message key and parameters:
7268 * `'descriptionmsg' => 'exampleextension-desc',`
7270 * - description: Description of extension as an inline string instead of
7271 * localizable message (omit in favour of 'descriptionmsg').
7273 * - license-name: Short name of the license (used as label for the link), such
7274 * as "GPL-2.0+" or "MIT" (https://spdx.org/licenses/ for a list of identifiers).
7276 $wgExtensionCredits = [];
7279 * Authentication plugin.
7280 * @var $wgAuth AuthPlugin
7281 * @deprecated since 1.27 use $wgAuthManagerConfig instead
7286 * Global list of hooks.
7288 * The key is one of the events made available by MediaWiki, you can find
7289 * a description for most of them in docs/hooks.txt. The array is used
7290 * internally by Hook:run().
7292 * The value can be one of:
7294 * - A function name:
7296 * $wgHooks['event_name'][] = $function;
7298 * - A function with some data:
7300 * $wgHooks['event_name'][] = [ $function, $data ];
7302 * - A an object method:
7304 * $wgHooks['event_name'][] = [ $object, 'method' ];
7308 * $wgHooks['event_name'][] = function ( $hookParam ) {
7309 * // Handler code goes here.
7313 * @warning You should always append to an event array or you will end up
7314 * deleting a previous registered hook.
7316 * @warning Hook handlers should be registered at file scope. Registering
7317 * handlers after file scope can lead to unexpected results due to caching.
7322 * List of service wiring files to be loaded by the default instance of MediaWikiServices.
7323 * Each file listed here is expected to return an associative array mapping service names
7324 * to instantiator functions. Extensions may add wiring files to define their own services.
7325 * However, this cannot be used to replace existing services - use the MediaWikiServices
7328 * @see MediaWikiServices
7329 * @see ServiceContainer::loadWiringFiles() for details on loading service instantiator functions.
7330 * @see docs/injection.txt for an overview of dependency injection in MediaWiki.
7332 $wgServiceWiringFiles = [
7333 __DIR__
. '/ServiceWiring.php'
7337 * Maps jobs to their handlers; extensions
7338 * can add to this to provide custom jobs.
7339 * A job handler should either be a class name to be instantiated,
7340 * or (since 1.30) a callback to use for creating the job object.
7343 'refreshLinks' => 'RefreshLinksJob',
7344 'deleteLinks' => 'DeleteLinksJob',
7345 'htmlCacheUpdate' => 'HTMLCacheUpdateJob',
7346 'sendMail' => 'EmaillingJob',
7347 'enotifNotify' => 'EnotifNotifyJob',
7348 'fixDoubleRedirect' => 'DoubleRedirectJob',
7349 'AssembleUploadChunks' => 'AssembleUploadChunksJob',
7350 'PublishStashedFile' => 'PublishStashedFileJob',
7351 'ThumbnailRender' => 'ThumbnailRenderJob',
7352 'recentChangesUpdate' => 'RecentChangesUpdateJob',
7353 'refreshLinksPrioritized' => 'RefreshLinksJob',
7354 'refreshLinksDynamic' => 'RefreshLinksJob',
7355 'activityUpdateJob' => 'ActivityUpdateJob',
7356 'categoryMembershipChange' => 'CategoryMembershipChangeJob',
7357 'cdnPurge' => 'CdnPurgeJob',
7358 'enqueue' => 'EnqueueJob', // local queue for multi-DC setups
7363 * Jobs that must be explicitly requested, i.e. aren't run by job runners unless
7364 * special flags are set. The values here are keys of $wgJobClasses.
7367 * - Very long-running jobs.
7368 * - Jobs that you would never want to run as part of a page rendering request.
7369 * - Jobs that you want to run on specialized machines ( like transcoding, or a particular
7370 * machine on your cluster has 'outside' web access you could restrict uploadFromUrl )
7371 * These settings should be global to all wikis.
7373 $wgJobTypesExcludedFromDefaultQueue = [ 'AssembleUploadChunks', 'PublishStashedFile' ];
7376 * Map of job types to how many job "work items" should be run per second
7377 * on each job runner process. The meaning of "work items" varies per job,
7378 * but typically would be something like "pages to update". A single job
7379 * may have a variable number of work items, as is the case with batch jobs.
7380 * This is used by runJobs.php and not jobs run via $wgJobRunRate.
7381 * These settings should be global to all wikis.
7384 $wgJobBackoffThrottling = [];
7387 * Make job runners commit changes for replica DB-lag prone jobs one job at a time.
7388 * This is useful if there are many job workers that race on replica DB lag checks.
7389 * If set, jobs taking this many seconds of DB write time have serialized commits.
7391 * Note that affected jobs may have worse lock contention. Also, if they affect
7392 * several DBs at once they may have a smaller chance of being atomic due to the
7393 * possibility of connection loss while queueing up to commit. Affected jobs may
7394 * also fail due to the commit lock acquisition timeout.
7399 $wgJobSerialCommitThreshold = false;
7402 * Map of job types to configuration arrays.
7403 * This determines which queue class and storage system is used for each job type.
7404 * Job types that do not have explicit configuration will use the 'default' config.
7405 * These settings should be global to all wikis.
7408 'default' => [ 'class' => 'JobQueueDB', 'order' => 'random', 'claimTTL' => 3600 ],
7412 * Which aggregator to use for tracking which queues have jobs.
7413 * These settings should be global to all wikis.
7415 $wgJobQueueAggregator = [
7416 'class' => 'JobQueueAggregatorNull'
7420 * Whether to include the number of jobs that are queued
7421 * for the API's maxlag parameter.
7422 * The total number of jobs will be divided by this to get an
7423 * estimated second of maxlag. Typically bots backoff at maxlag=5,
7424 * so setting this to the max number of jobs that should be in your
7425 * queue divided by 5 should have the effect of stopping bots once
7426 * that limit is hit.
7430 $wgJobQueueIncludeInMaxLagFactor = false;
7433 * Additional functions to be performed with updateSpecialPages.
7434 * Expensive Querypages are already updated.
7436 $wgSpecialPageCacheUpdates = [
7437 'Statistics' => [ 'SiteStatsUpdate', 'cacheUpdate' ]
7441 * Page property link table invalidation lists. When a page property
7442 * changes, this may require other link tables to be updated (eg
7443 * adding __HIDDENCAT__ means the hiddencat tracking category will
7444 * have been added, so the categorylinks table needs to be rebuilt).
7445 * This array can be added to by extensions.
7447 $wgPagePropLinkInvalidations = [
7448 'hiddencat' => 'categorylinks',
7451 /** @} */ # End extensions }
7453 /*************************************************************************//**
7459 * Use experimental, DMOZ-like category browser
7461 $wgUseCategoryBrowser = false;
7464 * On category pages, show thumbnail gallery for images belonging to that
7465 * category instead of listing them as articles.
7467 $wgCategoryMagicGallery = true;
7470 * Paging limit for categories
7472 $wgCategoryPagingLimit = 200;
7475 * Specify how category names should be sorted, when listed on a category page.
7476 * A sorting scheme is also known as a collation.
7478 * Available values are:
7480 * - uppercase: Converts the category name to upper case, and sorts by that.
7482 * - identity: Does no conversion. Sorts by binary value of the string.
7484 * - uca-default: Provides access to the Unicode Collation Algorithm with
7485 * the default element table. This is a compromise collation which sorts
7486 * all languages in a mediocre way. However, it is better than "uppercase".
7488 * To use the uca-default collation, you must have PHP's intl extension
7489 * installed. See https://secure.php.net/manual/en/intl.setup.php . The details of the
7490 * resulting collation will depend on the version of ICU installed on the
7493 * After you change this, you must run maintenance/updateCollation.php to fix
7494 * the sort keys in the database.
7496 * Extensions can define there own collations by subclassing Collation
7497 * and using the Collation::factory hook.
7499 $wgCategoryCollation = 'uppercase';
7501 /** @} */ # End categories }
7503 /*************************************************************************//**
7509 * The logging system has two levels: an event type, which describes the
7510 * general category and can be viewed as a named subset of all logs; and
7511 * an action, which is a specific kind of event that can exist in that
7532 * This restricts log access to those who have a certain right
7533 * Users without this will not see it in the option menu and can not view it
7534 * Restricted logs are not added to recent changes
7535 * Logs should remain non-transcludable
7536 * Format: logtype => permissiontype
7538 $wgLogRestrictions = [
7539 'suppress' => 'suppressionlog'
7543 * Show/hide links on Special:Log will be shown for these log types.
7545 * This is associative array of log type => boolean "hide by default"
7547 * See $wgLogTypes for a list of available log types.
7551 * $wgFilterLogTypes = [ 'move' => true, 'import' => false ];
7554 * Will display show/hide links for the move and import logs. Move logs will be
7555 * hidden by default unless the link is clicked. Import logs will be shown by
7556 * default, and hidden when the link is clicked.
7558 * A message of the form log-show-hide-[type] should be added, and will be used
7559 * for the link text.
7561 $wgFilterLogTypes = [
7567 * Lists the message key string for each log type. The localized messages
7568 * will be listed in the user interface.
7570 * Extensions with custom log types may add to this array.
7572 * @since 1.19, if you follow the naming convention log-name-TYPE,
7573 * where TYPE is your log type, yoy don't need to use this array.
7576 '' => 'all-logs-page',
7577 'block' => 'blocklogpage',
7578 'protect' => 'protectlogpage',
7579 'rights' => 'rightslog',
7580 'delete' => 'dellogpage',
7581 'upload' => 'uploadlogpage',
7582 'move' => 'movelogpage',
7583 'import' => 'importlogpage',
7584 'patrol' => 'patrol-log-page',
7585 'merge' => 'mergelog',
7586 'suppress' => 'suppressionlog',
7590 * Lists the message key string for descriptive text to be shown at the
7591 * top of each log type.
7593 * Extensions with custom log types may add to this array.
7595 * @since 1.19, if you follow the naming convention log-description-TYPE,
7596 * where TYPE is your log type, yoy don't need to use this array.
7599 '' => 'alllogstext',
7600 'block' => 'blocklogtext',
7601 'delete' => 'dellogpagetext',
7602 'import' => 'importlogpagetext',
7603 'merge' => 'mergelogpagetext',
7604 'move' => 'movelogpagetext',
7605 'patrol' => 'patrol-log-header',
7606 'protect' => 'protectlogtext',
7607 'rights' => 'rightslogtext',
7608 'suppress' => 'suppressionlogtext',
7609 'upload' => 'uploadlogpagetext',
7613 * Lists the message key string for formatting individual events of each
7614 * type and action when listed in the logs.
7616 * Extensions with custom log types may add to this array.
7621 * The same as above, but here values are names of classes,
7623 * @see LogPage::actionText
7626 $wgLogActionsHandlers = [
7627 'block/block' => 'BlockLogFormatter',
7628 'block/reblock' => 'BlockLogFormatter',
7629 'block/unblock' => 'BlockLogFormatter',
7630 'contentmodel/change' => 'ContentModelLogFormatter',
7631 'contentmodel/new' => 'ContentModelLogFormatter',
7632 'delete/delete' => 'DeleteLogFormatter',
7633 'delete/delete_redir' => 'DeleteLogFormatter',
7634 'delete/event' => 'DeleteLogFormatter',
7635 'delete/restore' => 'DeleteLogFormatter',
7636 'delete/revision' => 'DeleteLogFormatter',
7637 'import/interwiki' => 'ImportLogFormatter',
7638 'import/upload' => 'ImportLogFormatter',
7639 'managetags/activate' => 'LogFormatter',
7640 'managetags/create' => 'LogFormatter',
7641 'managetags/deactivate' => 'LogFormatter',
7642 'managetags/delete' => 'LogFormatter',
7643 'merge/merge' => 'MergeLogFormatter',
7644 'move/move' => 'MoveLogFormatter',
7645 'move/move_redir' => 'MoveLogFormatter',
7646 'patrol/patrol' => 'PatrolLogFormatter',
7647 'patrol/autopatrol' => 'PatrolLogFormatter',
7648 'protect/modify' => 'ProtectLogFormatter',
7649 'protect/move_prot' => 'ProtectLogFormatter',
7650 'protect/protect' => 'ProtectLogFormatter',
7651 'protect/unprotect' => 'ProtectLogFormatter',
7652 'rights/autopromote' => 'RightsLogFormatter',
7653 'rights/rights' => 'RightsLogFormatter',
7654 'suppress/block' => 'BlockLogFormatter',
7655 'suppress/delete' => 'DeleteLogFormatter',
7656 'suppress/event' => 'DeleteLogFormatter',
7657 'suppress/reblock' => 'BlockLogFormatter',
7658 'suppress/revision' => 'DeleteLogFormatter',
7659 'tag/update' => 'TagLogFormatter',
7660 'upload/overwrite' => 'UploadLogFormatter',
7661 'upload/revert' => 'UploadLogFormatter',
7662 'upload/upload' => 'UploadLogFormatter',
7666 * List of log types that can be filtered by action types
7668 * To each action is associated the list of log_action
7669 * subtypes to search for, usually one, but not necessarily so
7670 * Extensions may append to this array
7673 $wgActionFilteredLogs = [
7675 'block' => [ 'block' ],
7676 'reblock' => [ 'reblock' ],
7677 'unblock' => [ 'unblock' ],
7680 'change' => [ 'change' ],
7684 'delete' => [ 'delete' ],
7685 'delete_redir' => [ 'delete_redir' ],
7686 'restore' => [ 'restore' ],
7687 'event' => [ 'event' ],
7688 'revision' => [ 'revision' ],
7691 'interwiki' => [ 'interwiki' ],
7692 'upload' => [ 'upload' ],
7695 'create' => [ 'create' ],
7696 'delete' => [ 'delete' ],
7697 'activate' => [ 'activate' ],
7698 'deactivate' => [ 'deactivate' ],
7701 'move' => [ 'move' ],
7702 'move_redir' => [ 'move_redir' ],
7705 'create' => [ 'create', 'newusers' ],
7706 'create2' => [ 'create2' ],
7707 'autocreate' => [ 'autocreate' ],
7708 'byemail' => [ 'byemail' ],
7711 'patrol' => [ 'patrol' ],
7712 'autopatrol' => [ 'autopatrol' ],
7715 'protect' => [ 'protect' ],
7716 'modify' => [ 'modify' ],
7717 'unprotect' => [ 'unprotect' ],
7718 'move_prot' => [ 'move_prot' ],
7721 'rights' => [ 'rights' ],
7722 'autopromote' => [ 'autopromote' ],
7725 'event' => [ 'event' ],
7726 'revision' => [ 'revision' ],
7727 'delete' => [ 'delete' ],
7728 'block' => [ 'block' ],
7729 'reblock' => [ 'reblock' ],
7732 'upload' => [ 'upload' ],
7733 'overwrite' => [ 'overwrite' ],
7738 * Maintain a log of newusers at Log/newusers?
7740 $wgNewUserLog = true;
7742 /** @} */ # end logging }
7744 /*************************************************************************//**
7745 * @name Special pages (general and miscellaneous)
7750 * Allow special page inclusions such as {{Special:Allpages}}
7752 $wgAllowSpecialInclusion = true;
7755 * Set this to an array of special page names to prevent
7756 * maintenance/updateSpecialPages.php from updating those pages.
7758 $wgDisableQueryPageUpdate = false;
7761 * On Special:Unusedimages, consider images "used", if they are put
7762 * into a category. Default (false) is not to count those as used.
7764 $wgCountCategorizedImagesAsUsed = false;
7767 * Maximum number of links to a redirect page listed on
7768 * Special:Whatlinkshere/RedirectDestination
7770 $wgMaxRedirectLinksRetrieved = 500;
7772 /** @} */ # end special pages }
7774 /*************************************************************************//**
7780 * Array of allowed values for the "title=foo&action=<action>" parameter. Syntax is:
7781 * 'foo' => 'ClassName' Load the specified class which subclasses Action
7782 * 'foo' => true Load the class FooAction which subclasses Action
7783 * If something is specified in the getActionOverrides()
7784 * of the relevant Page object it will be used
7785 * instead of the default class.
7786 * 'foo' => false The action is disabled; show an error message
7787 * Unsetting core actions will probably cause things to complain loudly.
7793 'editchangetags' => 'SpecialPageAction',
7796 'markpatrolled' => true,
7802 'revisiondelete' => 'SpecialPageAction',
7805 'unprotect' => true,
7811 /** @} */ # end actions }
7813 /*************************************************************************//**
7814 * @name Robot (search engine crawler) policy
7815 * See also $wgNoFollowLinks.
7820 * Default robot policy. The default policy is to encourage indexing and fol-
7821 * lowing of links. It may be overridden on a per-namespace and/or per-page
7824 $wgDefaultRobotPolicy = 'index,follow';
7827 * Robot policies per namespaces. The default policy is given above, the array
7828 * is made of namespace constants as defined in includes/Defines.php. You can-
7829 * not specify a different default policy for NS_SPECIAL: it is always noindex,
7830 * nofollow. This is because a number of special pages (e.g., ListPages) have
7831 * many permutations of options that display the same data under redundant
7832 * URLs, so search engine spiders risk getting lost in a maze of twisty special
7833 * pages, all alike, and never reaching your actual content.
7837 * $wgNamespaceRobotPolicies = [ NS_TALK => 'noindex' ];
7840 $wgNamespaceRobotPolicies = [];
7843 * Robot policies per article. These override the per-namespace robot policies.
7844 * Must be in the form of an array where the key part is a properly canonicalised
7845 * text form title and the value is a robot policy.
7849 * $wgArticleRobotPolicies = [
7850 * 'Main Page' => 'noindex,follow',
7851 * 'User:Bob' => 'index,follow',
7855 * @par Example that DOES NOT WORK because the names are not canonical text
7858 * $wgArticleRobotPolicies = [
7859 * # Underscore, not space!
7860 * 'Main_Page' => 'noindex,follow',
7861 * # "Project", not the actual project name!
7862 * 'Project:X' => 'index,follow',
7863 * # Needs to be "Abc", not "abc" (unless $wgCapitalLinks is false for that namespace)!
7864 * 'abc' => 'noindex,nofollow'
7868 $wgArticleRobotPolicies = [];
7871 * An array of namespace keys in which the __INDEX__/__NOINDEX__ magic words
7872 * will not function, so users can't decide whether pages in that namespace are
7873 * indexed by search engines. If set to null, default to $wgContentNamespaces.
7877 * $wgExemptFromUserRobotsControl = [ NS_MAIN, NS_TALK, NS_PROJECT ];
7880 $wgExemptFromUserRobotsControl = null;
7882 /** @} */ # End robot policy }
7884 /************************************************************************//**
7885 * @name AJAX and API
7886 * Note: The AJAX entry point which this section refers to is gradually being
7887 * replaced by the API entry point, api.php. They are essentially equivalent.
7888 * Both of them are used for dynamic client-side features, via XHR.
7893 * Enable the MediaWiki API for convenient access to
7894 * machine-readable data via api.php
7896 * See https://www.mediawiki.org/wiki/API
7898 $wgEnableAPI = true;
7901 * Allow the API to be used to perform write operations
7902 * (page edits, rollback, etc.) when an authorised user
7905 $wgEnableWriteAPI = true;
7909 * WARNING: SECURITY THREAT - debug use only
7911 * Disables many security checks in the API for debugging purposes.
7912 * This flag should never be used on the production servers, as it introduces
7913 * a number of potential security holes. Even when enabled, the validation
7914 * will still be performed, but instead of failing, API will return a warning.
7915 * Also, there will always be a warning notifying that this flag is set.
7916 * At this point, the flag allows GET requests to go through for modules
7921 $wgDebugAPI = false;
7924 * API module extensions.
7926 * Associative array mapping module name to modules specs;
7927 * Each module spec is an associative array containing at least
7928 * the 'class' key for the module's class, and optionally a
7929 * 'factory' key for the factory function to use for the module.
7931 * That factory function will be called with two parameters,
7932 * the parent module (an instance of ApiBase, usually ApiMain)
7933 * and the name the module was registered under. The return
7934 * value must be an instance of the class given in the 'class'
7937 * For backward compatibility, the module spec may also be a
7938 * simple string containing the module's class name. In that
7939 * case, the class' constructor will be called with the parent
7940 * module and module name as parameters, as described above.
7942 * Examples for registering API modules:
7945 * $wgAPIModules['foo'] = 'ApiFoo';
7946 * $wgAPIModules['bar'] = [
7947 * 'class' => 'ApiBar',
7948 * 'factory' => function( $main, $name ) { ... }
7950 * $wgAPIModules['xyzzy'] = [
7951 * 'class' => 'ApiXyzzy',
7952 * 'factory' => [ 'XyzzyFactory', 'newApiModule' ]
7956 * Extension modules may override the core modules.
7957 * See ApiMain::$Modules for a list of the core modules.
7962 * API format module extensions.
7963 * Associative array mapping format module name to module specs (see $wgAPIModules).
7964 * Extension modules may override the core modules.
7966 * See ApiMain::$Formats for a list of the core format modules.
7968 $wgAPIFormatModules = [];
7971 * API Query meta module extensions.
7972 * Associative array mapping meta module name to module specs (see $wgAPIModules).
7973 * Extension modules may override the core modules.
7975 * See ApiQuery::$QueryMetaModules for a list of the core meta modules.
7977 $wgAPIMetaModules = [];
7980 * API Query prop module extensions.
7981 * Associative array mapping prop module name to module specs (see $wgAPIModules).
7982 * Extension modules may override the core modules.
7984 * See ApiQuery::$QueryPropModules for a list of the core prop modules.
7986 $wgAPIPropModules = [];
7989 * API Query list module extensions.
7990 * Associative array mapping list module name to module specs (see $wgAPIModules).
7991 * Extension modules may override the core modules.
7993 * See ApiQuery::$QueryListModules for a list of the core list modules.
7995 $wgAPIListModules = [];
7998 * Maximum amount of rows to scan in a DB query in the API
7999 * The default value is generally fine
8001 $wgAPIMaxDBRows = 5000;
8004 * The maximum size (in bytes) of an API result.
8005 * @warning Do not set this lower than $wgMaxArticleSize*1024
8007 $wgAPIMaxResultSize = 8388608;
8010 * The maximum number of uncached diffs that can be retrieved in one API
8011 * request. Set this to 0 to disable API diffs altogether
8013 $wgAPIMaxUncachedDiffs = 1;
8016 * Maximum amount of DB lag on a majority of DB replica DBs to tolerate
8017 * before forcing bots to retry any write requests via API errors.
8018 * This should be lower than the 'max lag' value in $wgLBFactoryConf.
8020 $wgAPIMaxLagThreshold = 7;
8023 * Log file or URL (TCP or UDP) to log API requests to, or false to disable
8024 * API request logging
8026 $wgAPIRequestLog = false;
8029 * Set the timeout for the API help text cache. If set to 0, caching disabled
8031 $wgAPICacheHelpTimeout = 60 * 60;
8034 * The ApiQueryQueryPages module should skip pages that are redundant to true
8037 $wgAPIUselessQueryPages = [
8038 'MIMEsearch', // aiprop=mime
8039 'LinkSearch', // list=exturlusage
8040 'FileDuplicateSearch', // prop=duplicatefiles
8044 * Enable AJAX framework
8049 * List of Ajax-callable functions.
8050 * Extensions acting as Ajax callbacks must register here
8051 * @deprecated (officially) since 1.27; use the API instead
8053 $wgAjaxExportList = [];
8056 * Enable AJAX check for file overwrite, pre-upload
8058 $wgAjaxUploadDestCheck = true;
8061 * Enable previewing licences via AJAX. Also requires $wgEnableAPI to be true.
8063 $wgAjaxLicensePreview = true;
8066 * Have clients send edits to be prepared when filling in edit summaries.
8067 * This gives the server a head start on the expensive parsing operation.
8069 $wgAjaxEditStash = true;
8072 * Settings for incoming cross-site AJAX requests:
8073 * Newer browsers support cross-site AJAX when the target resource allows requests
8074 * from the origin domain by the Access-Control-Allow-Origin header.
8075 * This is currently only used by the API (requests to api.php)
8076 * $wgCrossSiteAJAXdomains can be set using a wildcard syntax:
8078 * - '*' matches any number of characters
8079 * - '?' matches any 1 character
8083 * $wgCrossSiteAJAXdomains = [
8084 * 'www.mediawiki.org',
8085 * '*.wikipedia.org',
8086 * '*.wikimedia.org',
8087 * '*.wiktionary.org',
8091 $wgCrossSiteAJAXdomains = [];
8094 * Domains that should not be allowed to make AJAX requests,
8095 * even if they match one of the domains allowed by $wgCrossSiteAJAXdomains
8096 * Uses the same syntax as $wgCrossSiteAJAXdomains
8098 $wgCrossSiteAJAXdomainExceptions = [];
8100 /** @} */ # End AJAX and API }
8102 /************************************************************************//**
8103 * @name Shell and process control
8108 * Maximum amount of virtual memory available to shell processes under linux, in KB.
8110 $wgMaxShellMemory = 307200;
8113 * Maximum file size created by shell processes under linux, in KB
8114 * ImageMagick convert for example can be fairly hungry for scratch space
8116 $wgMaxShellFileSize = 102400;
8119 * Maximum CPU time in seconds for shell processes under Linux
8121 $wgMaxShellTime = 180;
8124 * Maximum wall clock time (i.e. real time, of the kind the clock on the wall
8125 * would measure) in seconds for shell processes under Linux
8127 $wgMaxShellWallClockTime = 180;
8130 * Under Linux: a cgroup directory used to constrain memory usage of shell
8131 * commands. The directory must be writable by the user which runs MediaWiki.
8133 * If specified, this is used instead of ulimit, which is inaccurate, and
8134 * causes malloc() to return NULL, which exposes bugs in C applications, making
8135 * them segfault or deadlock.
8137 * A wrapper script will create a cgroup for each shell command that runs, as
8138 * a subgroup of the specified cgroup. If the memory limit is exceeded, the
8139 * kernel will send a SIGKILL signal to a process in the subgroup.
8143 * mkdir -p /sys/fs/cgroup/memory/mediawiki
8144 * mkdir -m 0777 /sys/fs/cgroup/memory/mediawiki/job
8145 * echo '$wgShellCgroup = "/sys/fs/cgroup/memory/mediawiki/job";' >> LocalSettings.php
8148 * The reliability of cgroup cleanup can be improved by installing a
8149 * notify_on_release script in the root cgroup, see e.g.
8150 * https://gerrit.wikimedia.org/r/#/c/40784
8152 $wgShellCgroup = false;
8155 * Executable path of the PHP cli binary (php/php5). Should be set up on install.
8157 $wgPhpCli = '/usr/bin/php';
8160 * Locale for LC_ALL, to provide a known environment for locale-sensitive operations
8162 * For Unix-like operating systems, this should be set to C.UTF-8 or an
8163 * equivalent to provide the most consistent behavior for locale-sensitive
8164 * C library operations across different-language wikis. If that locale is not
8165 * available, use another locale that has a UTF-8 character set.
8167 * This setting mainly affects the behavior of C library functions, including:
8168 * - String collation (order when sorting using locale-sensitive comparison)
8169 * - For example, whether "Å" and "A" are considered to be the same letter or
8170 * different letters and if different whether it comes after "A" or after
8171 * "Z", and whether sorting is case sensitive.
8172 * - String character set (how characters beyond basic ASCII are represented)
8173 * - We need this to be a UTF-8 character set to work around
8174 * https://bugs.php.net/bug.php?id=45132
8175 * - Language used for low-level error messages.
8176 * - Formatting of date/time and numeric values (e.g. '.' versus ',' as the
8177 * decimal separator)
8179 * MediaWiki provides its own methods and classes to perform many
8180 * locale-sensitive operations, which are designed to be able to vary locale
8181 * based on wiki language or user preference:
8182 * - MediaWiki's Collation class should generally be used instead of the C
8183 * library collation functions when locale-sensitive sorting is needed.
8184 * - MediaWiki's Message class should be used for localization of messages
8185 * displayed to the user.
8186 * - MediaWiki's Language class should be used for formatting numeric and
8189 * @note If multiple wikis are being served from the same process (e.g. the
8190 * same fastCGI or Apache server), this setting must be the same on all those
8193 $wgShellLocale = 'C.UTF-8';
8195 /** @} */ # End shell }
8197 /************************************************************************//**
8203 * Timeout for HTTP requests done internally, in seconds.
8205 $wgHTTPTimeout = 25;
8208 * Timeout for HTTP requests done internally for transwiki imports, in seconds.
8211 $wgHTTPImportTimeout = 25;
8214 * Timeout for Asynchronous (background) HTTP requests, in seconds.
8216 $wgAsyncHTTPTimeout = 25;
8219 * Proxy to use for CURL requests.
8221 $wgHTTPProxy = false;
8224 * Local virtual hosts.
8226 * This lists domains that are configured as virtual hosts on the same machine.
8227 * If a request is to be made to a domain listed here, or any subdomain thereof,
8228 * then no proxy will be used.
8229 * Command-line scripts are not affected by this setting and will always use
8230 * proxy if it is configured.
8233 $wgLocalVirtualHosts = [];
8236 * Timeout for connections done internally (in seconds)
8237 * Only works for curl
8239 $wgHTTPConnectTimeout = 5e0
;
8241 /** @} */ # End HTTP client }
8243 /************************************************************************//**
8249 * Number of jobs to perform per request. May be less than one in which case
8250 * jobs are performed probabalistically. If this is zero, jobs will not be done
8251 * during ordinary apache requests. In this case, maintenance/runJobs.php should
8252 * be run periodically.
8257 * When $wgJobRunRate > 0, try to run jobs asynchronously, spawning a new process
8258 * to handle the job execution, instead of blocking the request until the job
8259 * execution finishes.
8263 $wgRunJobsAsync = false;
8266 * Number of rows to update per job
8268 $wgUpdateRowsPerJob = 300;
8271 * Number of rows to update per query
8273 $wgUpdateRowsPerQuery = 100;
8275 /** @} */ # End job queue }
8277 /************************************************************************//**
8278 * @name Miscellaneous
8283 * Name of the external diff engine to use. Supported values:
8284 * * string: path to an external diff executable
8285 * * false: wikidiff2 PHP/HHVM module if installed, otherwise the default PHP implementation
8286 * * 'wikidiff', 'wikidiff2', and 'wikidiff3' are treated as false for backwards compatibility
8288 $wgExternalDiffEngine = false;
8291 * Disable redirects to special pages and interwiki redirects, which use a 302
8292 * and have no "redirected from" link.
8294 * @note This is only for articles with #REDIRECT in them. URL's containing a
8295 * local interwiki prefix (or a non-canonical special page name) are still hard
8296 * redirected regardless of this setting.
8298 $wgDisableHardRedirects = false;
8301 * LinkHolderArray batch size
8304 $wgLinkHolderBatchSize = 1000;
8307 * By default MediaWiki does not register links pointing to same server in
8308 * externallinks dataset, use this value to override:
8310 $wgRegisterInternalExternals = false;
8313 * Maximum number of pages to move at once when moving subpages with a page.
8315 $wgMaximumMovedPages = 100;
8318 * Fix double redirects after a page move.
8319 * Tends to conflict with page move vandalism, use only on a private wiki.
8321 $wgFixDoubleRedirects = false;
8324 * Allow redirection to another page when a user logs in.
8325 * To enable, set to a string like 'Main Page'
8327 $wgRedirectOnLogin = null;
8330 * Configuration for processing pool control, for use in high-traffic wikis.
8331 * An implementation is provided in the PoolCounter extension.
8333 * This configuration array maps pool types to an associative array. The only
8334 * defined key in the associative array is "class", which gives the class name.
8335 * The remaining elements are passed through to the class as constructor
8338 * @par Example using local redis instance:
8340 * $wgPoolCounterConf = [ 'ArticleView' => [
8341 * 'class' => 'PoolCounterRedis',
8342 * 'timeout' => 15, // wait timeout in seconds
8343 * 'workers' => 1, // maximum number of active threads in each pool
8344 * 'maxqueue' => 5, // maximum number of total threads in each pool
8345 * 'servers' => [ '127.0.0.1' ],
8346 * 'redisConfig' => []
8350 * @par Example using C daemon from https://www.mediawiki.org/wiki/Extension:PoolCounter:
8352 * $wgPoolCounterConf = [ 'ArticleView' => [
8353 * 'class' => 'PoolCounter_Client',
8354 * 'timeout' => 15, // wait timeout in seconds
8355 * 'workers' => 5, // maximum number of active threads in each pool
8356 * 'maxqueue' => 50, // maximum number of total threads in each pool
8357 * ... any extension-specific options...
8361 $wgPoolCounterConf = null;
8364 * To disable file delete/restore temporarily
8366 $wgUploadMaintenance = false;
8369 * Associative array mapping namespace IDs to the name of the content model pages in that namespace
8370 * should have by default (use the CONTENT_MODEL_XXX constants). If no special content type is
8371 * defined for a given namespace, pages in that namespace will use the CONTENT_MODEL_WIKITEXT
8372 * (except for the special case of JS and CS pages).
8376 $wgNamespaceContentModels = [];
8379 * How to react if a plain text version of a non-text Content object is requested using
8380 * ContentHandler::getContentText():
8382 * * 'ignore': return null
8383 * * 'fail': throw an MWException
8384 * * 'serialize': serialize to default format
8388 $wgContentHandlerTextFallback = 'ignore';
8391 * Set to false to disable use of the database fields introduced by the ContentHandler facility.
8392 * This way, the ContentHandler facility can be used without any additional information in the
8393 * database. A page's content model is then derived solely from the page's title. This however
8394 * means that changing a page's default model (e.g. using $wgNamespaceContentModels) will break
8395 * the page and/or make the content inaccessible. This also means that pages can not be moved to
8396 * a title that would default to a different content model.
8398 * Overall, with $wgContentHandlerUseDB = false, no database updates are needed, but content
8399 * handling is less robust and less flexible.
8403 $wgContentHandlerUseDB = true;
8406 * Determines which types of text are parsed as wikitext. This does not imply that these kinds
8407 * of texts are also rendered as wikitext, it only means that links, magic words, etc will have
8408 * the effect on the database they would have on a wikitext page.
8410 * @todo On the long run, it would be nice to put categories etc into a separate structure,
8411 * or at least parse only the contents of comments in the scripts.
8415 $wgTextModelsToParse = [
8416 CONTENT_MODEL_WIKITEXT
, // Just for completeness, wikitext will always be parsed.
8417 CONTENT_MODEL_JAVASCRIPT
, // Make categories etc work, people put them into comments.
8418 CONTENT_MODEL_CSS
, // Make categories etc work, people put them into comments.
8422 * Register handlers for specific types of sites.
8427 'mediawiki' => 'MediaWikiSite',
8431 * Whether the page_props table has a pp_sortkey column. Set to false in case
8432 * the respective database schema change was not applied.
8435 $wgPagePropsHaveSortkey = true;
8438 * Port where you have HTTPS running
8439 * Supports HTTPS on non-standard ports
8446 * Secret for session storage.
8447 * This should be set in LocalSettings.php, otherwise wgSecretKey will
8451 $wgSessionSecret = false;
8454 * If for some reason you can't install the PHP OpenSSL or mcrypt extensions,
8455 * you can set this to true to make MediaWiki work again at the cost of storing
8456 * sensitive session data insecurely. But it would be much more secure to just
8457 * install the OpenSSL extension.
8460 $wgSessionInsecureSecrets = false;
8463 * Secret for hmac-based key derivation function (fast,
8464 * cryptographically secure random numbers).
8465 * This should be set in LocalSettings.php, otherwise wgSecretKey will
8467 * See also: $wgHKDFAlgorithm
8470 $wgHKDFSecret = false;
8473 * Algorithm for hmac-based key derivation function (fast,
8474 * cryptographically secure random numbers).
8475 * See also: $wgHKDFSecret
8478 $wgHKDFAlgorithm = 'sha256';
8481 * Enable page language feature
8482 * Allows setting page language in database
8486 $wgPageLanguageUseDB = false;
8489 * Global configuration variable for Virtual REST Services.
8491 * Use the 'path' key to define automatically mounted services. The value for this
8492 * key is a map of path prefixes to service configuration. The latter is an array of:
8493 * - class : the fully qualified class name
8494 * - options : map of arguments to the class constructor
8495 * Such services will be available to handle queries under their path from the VRS
8496 * singleton, e.g. MediaWikiServices::getInstance()->getVirtualRESTServiceClient();
8498 * Auto-mounting example for Parsoid:
8500 * $wgVirtualRestConfig['paths']['/parsoid/'] = [
8501 * 'class' => 'ParsoidVirtualRESTService',
8503 * 'url' => 'http://localhost:8000',
8504 * 'prefix' => 'enwiki',
8505 * 'domain' => 'en.wikipedia.org'
8509 * Parameters for different services can also be declared inside the 'modules' value,
8510 * which is to be treated as an associative array. The parameters in 'global' will be
8511 * merged with service-specific ones. The result will then be passed to
8512 * VirtualRESTService::__construct() in the module.
8514 * Example config for Parsoid:
8516 * $wgVirtualRestConfig['modules']['parsoid'] = [
8517 * 'url' => 'http://localhost:8000',
8518 * 'prefix' => 'enwiki',
8519 * 'domain' => 'en.wikipedia.org',
8525 $wgVirtualRestConfig = [
8529 # Timeout in seconds
8531 # 'domain' is set to $wgCanonicalServer in Setup.php
8532 'forwardCookies' => false,
8538 * Controls whether zero-result search queries with suggestions should display results for
8539 * these suggestions.
8544 $wgSearchRunSuggestedQuery = true;
8547 * Where popular password file is located.
8549 * Default in core contains 10,000 most popular. This config
8550 * allows you to change which file, in case you want to generate
8551 * a password file with > 10000 entries in it.
8553 * @see maintenance/createCommonPasswordCdb.php
8555 * @var string path to file
8557 $wgPopularPasswordFile = __DIR__
. '/../serialized/commonpasswords.cdb';
8560 * Max time (in seconds) a user-generated transaction can spend in writes.
8561 * If exceeded, the transaction is rolled back with an error instead of being committed.
8563 * @var int|bool Disabled if false
8566 $wgMaxUserDBWriteDuration = false;
8569 * Max time (in seconds) a job-generated transaction can spend in writes.
8570 * If exceeded, the transaction is rolled back with an error instead of being committed.
8572 * @var int|bool Disabled if false
8575 $wgMaxJobDBWriteDuration = false;
8578 * Mapping of event channels (or channel categories) to EventRelayer configuration.
8580 * By setting up a PubSub system (like Kafka) and enabling a corresponding EventRelayer class
8581 * that uses it, MediaWiki can broadcast events to all subscribers. Certain features like WAN
8582 * cache purging and CDN cache purging will emit events to this system. Appropriate listers can
8583 * subscribe to the channel and take actions based on the events. For example, a local daemon
8584 * can run on each CDN cache node and perfom local purges based on the URL purge channel events.
8586 * Some extensions may want to use "channel categories" so that different channels can also share
8587 * the same custom relayer instance (e.g. when it's likely to be overriden). They can use
8588 * EventRelayerGroup::getRelayer() based on the category but call notify() on various different
8589 * actual channels. One reason for this would be that some system have very different performance
8590 * vs durability needs, so one system (e.g. Kafka) may not be suitable for all uses.
8592 * The 'default' key is for all channels (or channel categories) without an explicit entry here.
8596 $wgEventRelayerConfig = [
8598 'class' => 'EventRelayerNull',
8603 * Share data about this installation with MediaWiki developers
8605 * When set to true, MediaWiki will periodically ping https://www.mediawiki.org/ with basic
8606 * data about this MediaWiki instance. This data includes, for example, the type of system,
8607 * PHP version, and chosen database backend. The Wikimedia Foundation shares this data with
8608 * MediaWiki developers to help guide future development efforts.
8610 * For details about what data is sent, see: https://www.mediawiki.org/wiki/Manual:$wgPingback
8615 $wgPingback = false;
8618 * List of urls which appear often to be triggering CSP reports
8619 * but do not appear to be caused by actual content, but by client
8620 * software inserting scripts (i.e. Ad-Ware).
8621 * List based on results from Wikimedia logs.
8625 $wgCSPFalsePositiveUrls = [
8626 'https://3hub.co' => true,
8627 'https://morepro.info' => true,
8628 'https://p.ato.mx' => true,
8629 'https://s.ato.mx' => true,
8630 'https://adserver.adtech.de' => true,
8631 'https://ums.adtechus.com' => true,
8632 'https://cas.criteo.com' => true,
8633 'https://cat.nl.eu.criteo.com' => true,
8634 'https://atpixel.alephd.com' => true,
8635 'https://rtb.metrigo.com' => true,
8636 'https://d5p.de17a.com' => true,
8637 'https://ad.lkqd.net/vpaid/vpaid.js' => true,
8641 * The following variables define 3 user experience levels:
8643 * - newcomer: has not yet reached the 'learner' level
8645 * - learner: has at least $wgLearnerEdits and has been
8646 * a member for $wgLearnerMemberSince days
8647 * but has not yet reached the 'experienced' level.
8649 * - experienced: has at least $wgExperiencedUserEdits edits and
8650 * has been a member for $wgExperiencedUserMemberSince days.
8652 $wgLearnerEdits = 10;
8653 $wgLearnerMemberSince = 4; # days
8654 $wgExperiencedUserEdits = 500;
8655 $wgExperiencedUserMemberSince = 30; # days
8658 * Mapping of interwiki index prefixes to descriptors that
8659 * can be used to change the display of interwiki search results.
8661 * Descriptors are appended to CSS classes of interwiki results
8662 * which using InterwikiSearchResultWidget.
8664 * Predefined descriptors include the following words:
8665 * definition, textbook, news, quotation, book, travel, course
8669 * $wgInterwikiPrefixDisplayTypes = [
8670 * 'iwprefix' => 'definition'
8674 $wgInterwikiPrefixDisplayTypes = [];
8677 * For really cool vim folding this needs to be at the end:
8678 * vim: foldmarker=@{,@} foldmethod=marker