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
40 use MediaWiki\MediaWikiServices
;
43 * @cond file_level_code
44 * This is not a valid entry point, perform no further processing unless
45 * MEDIAWIKI is defined
47 if ( !defined( 'MEDIAWIKI' ) ) {
48 echo "This file is part of MediaWiki and is not a valid entry point\n";
55 * wgConf hold the site configuration.
56 * Not used for much in a default install.
59 $wgConf = new SiteConfiguration
;
62 * Registry of factory functions to create config objects:
63 * The 'main' key must be set, and the value should be a valid
68 'main' => 'GlobalVarConfig::newInstance'
72 * MediaWiki version number
75 $wgVersion = '1.34.0-alpha';
78 * Name of the site. It must be changed in LocalSettings.php
80 $wgSitename = 'MediaWiki';
83 * When the wiki is running behind a proxy and this is set to true, assumes that the proxy exposes
84 * the wiki on the standard ports (443 for https and 80 for http).
88 $wgAssumeProxiesUseDefaultProtocolPorts = true;
95 * $wgServer = 'http://example.com';
98 * This is usually detected correctly by MediaWiki. If MediaWiki detects the
99 * wrong server, it will redirect incorrectly after you save a page. In that
100 * case, set this variable to fix it.
102 * If you want to use protocol-relative URLs on your wiki, set this to a
103 * protocol-relative URL like '//example.com' and set $wgCanonicalServer
104 * to a fully qualified URL.
106 $wgServer = WebRequest
::detectServer();
109 * Canonical URL of the server, to use in IRC feeds and notification e-mails.
110 * Must be fully qualified, even if $wgServer is protocol-relative.
112 * Defaults to $wgServer, expanded to a fully qualified http:// URL if needed.
115 $wgCanonicalServer = false;
118 * Server name. This is automatically computed by parsing the bare
119 * hostname out of $wgCanonicalServer. It should not be customized.
122 $wgServerName = false;
124 /************************************************************************//**
125 * @name Script path settings
130 * The path we should point to.
131 * It might be a virtual path in case with use apache mod_rewrite for example.
133 * This *needs* to be set correctly.
135 * Other paths will be set to defaults based on it unless they are directly
136 * set in LocalSettings.php
138 $wgScriptPath = '/wiki';
141 * Whether to support URLs like index.php/Page_title These often break when PHP
142 * is set up in CGI mode. PATH_INFO *may* be correct if cgi.fix_pathinfo is set,
143 * but then again it may not; lighttpd converts incoming path data to lowercase
144 * on systems with case-insensitive filesystems, and there have been reports of
145 * problems on Apache as well.
147 * To be safe we'll continue to keep it off by default.
149 * Override this to false if $_SERVER['PATH_INFO'] contains unexpectedly
150 * incorrect garbage, or to true if it is really correct.
152 * The default $wgArticlePath will be set based on this value at runtime, but if
153 * you have customized it, having this incorrectly set to true can cause
154 * redirect loops when "pretty URLs" are used.
157 $wgUsePathInfo = ( strpos( PHP_SAPI
, 'cgi' ) === false ) &&
158 ( strpos( PHP_SAPI
, 'apache2filter' ) === false ) &&
159 ( strpos( PHP_SAPI
, 'isapi' ) === false );
163 /************************************************************************//**
164 * @name URLs and file paths
166 * These various web and file path variables are set to their defaults
167 * in Setup.php if they are not explicitly set from LocalSettings.php.
169 * These will relatively rarely need to be set manually, unless you are
170 * splitting style sheets or images outside the main document root.
172 * In this section, a "path" is usually a host-relative URL, i.e. a URL without
173 * the host part, that starts with a slash. In most cases a full URL is also
174 * acceptable. A "directory" is a local file path.
176 * In both paths and directories, trailing slashes should not be included.
182 * The URL path to index.php.
184 * Defaults to "{$wgScriptPath}/index.php".
189 * The URL path to load.php.
191 * Defaults to "{$wgScriptPath}/load.php".
194 $wgLoadScript = false;
197 * The URL path to the REST API
198 * Defaults to "{$wgScriptPath}/rest.php"
204 * The URL path of the skins directory.
205 * Defaults to "{$wgResourceBasePath}/skins".
208 $wgStylePath = false;
209 $wgStyleSheetPath = &$wgStylePath;
212 * The URL path of the skins directory. Should not point to an external domain.
213 * Defaults to "{$wgScriptPath}/skins".
216 $wgLocalStylePath = false;
219 * The URL path of the extensions directory.
220 * Defaults to "{$wgResourceBasePath}/extensions".
223 $wgExtensionAssetsPath = false;
226 * Filesystem extensions directory.
227 * Defaults to "{$IP}/extensions".
230 $wgExtensionDirectory = "{$IP}/extensions";
233 * Filesystem stylesheets directory.
234 * Defaults to "{$IP}/skins".
237 $wgStyleDirectory = "{$IP}/skins";
240 * The URL path for primary article page views. This path should contain $1,
241 * which is replaced by the article title.
243 * Defaults to "{$wgScript}/$1" or "{$wgScript}?title=$1",
244 * depending on $wgUsePathInfo.
246 $wgArticlePath = false;
249 * The URL path for the images directory.
250 * Defaults to "{$wgScriptPath}/images".
252 $wgUploadPath = false;
255 * The filesystem path of the images directory. Defaults to "{$IP}/images".
257 $wgUploadDirectory = false;
260 * Directory where the cached page will be saved.
261 * Defaults to "{$wgUploadDirectory}/cache".
263 $wgFileCacheDirectory = false;
266 * The URL path of the wiki logo. The logo size should be 135x135 pixels.
267 * Defaults to "$wgResourceBasePath/resources/assets/wiki.png".
272 * Array with URL paths to HD versions of the wiki logo. The scaled logo size
273 * should be under 135x155 pixels.
274 * Only 1.5x and 2x versions are supported.
279 * "1.5x" => "path/to/1.5x_version.png",
280 * "2x" => "path/to/2x_version.png"
284 * SVG is also supported but when enabled, it
285 * disables 1.5x and 2x as svg will already
286 * be optimised for screen resolution.
291 * "svg" => "path/to/svg_version.svg",
300 * The URL path of the shortcut icon.
303 $wgFavicon = '/favicon.ico';
306 * The URL path of the icon for iPhone and iPod Touch web app bookmarks.
307 * Defaults to no icon.
310 $wgAppleTouchIcon = false;
313 * Value for the referrer policy meta tag.
314 * One or more of the values defined in the Referrer Policy specification:
315 * https://w3c.github.io/webappsec-referrer-policy/
316 * ('no-referrer', 'no-referrer-when-downgrade', 'same-origin',
317 * 'origin', 'strict-origin', 'origin-when-cross-origin',
318 * 'strict-origin-when-cross-origin', or 'unsafe-url')
319 * Setting it to false prevents the meta tag from being output
320 * (which results in falling back to the Referrer-Policy header,
321 * or 'no-referrer-when-downgrade' if that's not set either.)
322 * Setting it to an array (supported since 1.31) will create a meta tag for
323 * each value, in the reverse of the order (meaning that the first array element
324 * will be the default and the others used as fallbacks for browsers which do not
327 * @var array|string|bool
330 $wgReferrerPolicy = false;
333 * The local filesystem path to a temporary directory. This must not be web accessible.
335 * When this setting is set to false, its value will automatically be decided
336 * through the first call to wfTempDir(). See that method's implementation for
337 * the actual detection logic.
339 * To find the temporary path for the current wiki, developers must not use
340 * this variable directly. Use the global function wfTempDir() instead.
342 * The temporary directory is expected to be shared with other applications,
343 * including other MediaWiki instances (which might not run the same version
344 * or configution). When storing files here, take care to avoid conflicts
345 * with other instances of MediaWiki. For example, when caching the result
346 * of a computation, the file name should incorporate the input of the
347 * computation so that it cannot be confused for the result of a similar
348 * computation by another MediaWiki instance.
351 * @note Default changed to false in MediaWiki 1.20.
353 $wgTmpDirectory = false;
356 * If set, this URL is added to the start of $wgUploadPath to form a complete
360 $wgUploadBaseUrl = '';
363 * To enable remote on-demand scaling, set this to the thumbnail base URL.
364 * Full thumbnail URL will be like $wgUploadStashScalerBaseUrl/e/e6/Foo.jpg/123px-Foo.jpg
365 * where 'e6' are the first two characters of the MD5 hash of the file name.
366 * If $wgUploadStashScalerBaseUrl is set to false, thumbs are rendered locally as needed.
369 $wgUploadStashScalerBaseUrl = false;
372 * To set 'pretty' URL paths for actions other than
373 * plain page views, add to this array.
376 * Set pretty URL for the edit action:
378 * 'edit' => "$wgScriptPath/edit/$1"
381 * There must be an appropriate script or rewrite rule in place to handle these
389 /************************************************************************//**
390 * @name Files and file uploads
395 * Allow users to upload files.
397 * Use $wgLocalFileRepo to control how and where uploads are stored.
398 * Disabled by default as for security reasons.
399 * See <https://www.mediawiki.org/wiki/Manual:Configuring_file_uploads>.
403 $wgEnableUploads = false;
406 * The maximum age of temporary (incomplete) uploaded files
408 $wgUploadStashMaxAge = 6 * 3600; // 6 hours
411 * Allows to move images and other media files
413 $wgAllowImageMoving = true;
416 * Enable deferred upload tasks that use the job queue.
417 * Only enable this if job runners are set up for both the
418 * 'AssembleUploadChunks' and 'PublishStashedFile' job types.
420 * @note If you use suhosin, this setting is incompatible with
421 * suhosin.session.encrypt.
423 $wgEnableAsyncUploads = false;
426 * Additional characters that are not allowed in filenames. They are replaced with '-' when
427 * uploading. Like $wgLegalTitleChars, this is a regexp character class.
429 * Slashes and backslashes are disallowed regardless of this setting, but included here for
432 $wgIllegalFileChars = ":\\/\\\\";
435 * What directory to place deleted uploads in.
436 * Defaults to "{$wgUploadDirectory}/deleted".
438 $wgDeletedDirectory = false;
441 * Set this to true if you use img_auth and want the user to see details on why access failed.
443 $wgImgAuthDetails = false;
446 * Map of relative URL directories to match to internal mwstore:// base storage paths.
447 * For img_auth.php requests, everything after "img_auth.php/" is checked to see
448 * if starts with any of the prefixes defined here. The prefixes should not overlap.
449 * The prefix that matches has a corresponding storage path, which the rest of the URL
450 * is assumed to be relative to. The file at that path (or a 404) is send to the client.
453 * $wgImgAuthUrlPathMap['/timeline/'] = 'mwstore://local-fs/timeline-render/';
454 * The above maps ".../img_auth.php/timeline/X" to "mwstore://local-fs/timeline-render/".
455 * The name "local-fs" should correspond by name to an entry in $wgFileBackends.
457 * @see $wgFileBackends
459 $wgImgAuthUrlPathMap = [];
462 * File repository structures
464 * $wgLocalFileRepo is a single repository structure, and $wgForeignFileRepos is
465 * an array of such structures. Each repository structure is an associative
466 * array of properties configuring the repository.
468 * Properties required for all repos:
469 * - class The class name for the repository. May come from the core or an extension.
470 * The core repository classes are FileRepo, LocalRepo, ForeignDBRepo.
472 * - name A unique name for the repository (but $wgLocalFileRepo should be 'local').
473 * The name should consist of alpha-numeric characters.
474 * - backend A file backend name (see $wgFileBackends).
476 * For most core repos:
477 * - zones Associative array of zone names that each map to an array with:
478 * container : backend container name the zone is in
479 * directory : root path within container for the zone
480 * url : base URL to the root of the zone
481 * urlsByExt : map of file extension types to base URLs
482 * (useful for using a different cache for videos)
483 * Zones default to using "<repo name>-<zone name>" as the container name
484 * and default to using the container root as the zone's root directory.
485 * Nesting of zone locations within other zones should be avoided.
486 * - url Public zone URL. The 'zones' settings take precedence.
487 * - hashLevels The number of directory levels for hash-based division of files
488 * - thumbScriptUrl The URL for thumb.php (optional, not recommended)
489 * - transformVia404 Whether to skip media file transformation on parse and rely on a 404
491 * - initialCapital Equivalent to $wgCapitalLinks (or $wgCapitalLinkOverrides[NS_FILE],
492 * determines whether filenames implicitly start with a capital letter.
493 * The current implementation may give incorrect description page links
494 * when the local $wgCapitalLinks and initialCapital are mismatched.
495 * - pathDisclosureProtection
496 * May be 'paranoid' to remove all parameters from error messages, 'none' to
497 * leave the paths in unchanged, or 'simple' to replace paths with
498 * placeholders. Default for LocalRepo is 'simple'.
499 * - fileMode This allows wikis to set the file mode when uploading/moving files. Default
501 * - directory The local filesystem directory where public files are stored. Not used for
503 * - thumbDir The base thumbnail directory. Defaults to "<directory>/thumb".
504 * - thumbUrl The base thumbnail URL. Defaults to "<url>/thumb".
505 * - isPrivate Set this if measures should always be taken to keep the files private.
506 * One should not trust this to assure that the files are not web readable;
507 * the server configuration should be done manually depending on the backend.
509 * These settings describe a foreign MediaWiki installation. They are optional, and will be ignored
510 * for local repositories:
511 * - descBaseUrl URL of image description pages, e.g. https://en.wikipedia.org/wiki/File:
512 * - scriptDirUrl URL of the MediaWiki installation, equivalent to $wgScriptPath, e.g.
513 * https://en.wikipedia.org/w
514 * - articleUrl Equivalent to $wgArticlePath, e.g. https://en.wikipedia.org/wiki/$1
515 * - fetchDescription Fetch the text of the remote file description page and display them
517 * - abbrvThreshold File names over this size will use the short form of thumbnail names.
518 * Short thumbnail names only have the width, parameters, and the extension.
521 * - dbType, dbServer, dbUser, dbPassword, dbName, dbFlags
522 * equivalent to the corresponding member of $wgDBservers
523 * - tablePrefix Table prefix, the foreign wiki's $wgDBprefix
524 * - hasSharedCache Set to true if the foreign wiki's $wgMainCacheType is identical to,
525 * and accessible from, this wiki.
528 * - apibase Use for the foreign API's URL
529 * - apiThumbCacheExpiry How long to locally cache thumbs for
531 * If you leave $wgLocalFileRepo set to false, Setup will fill in appropriate values.
532 * Otherwise, set $wgLocalFileRepo to a repository structure as described above.
533 * If you set $wgUseInstantCommons to true, it will add an entry for Commons.
534 * If you set $wgForeignFileRepos to an array of repository structures, those will
535 * be searched after the local file repo.
536 * Otherwise, you will only have access to local media files.
538 * @see Setup.php for an example usage and default initialization.
540 $wgLocalFileRepo = false;
543 * Enable the use of files from one or more other wikis.
545 * If you operate multiple wikis, you can declare a shared upload path here.
546 * Uploads to the local wiki will NOT be stored here - See $wgLocalFileRepo
547 * and $wgUploadDirectory for that.
549 * The wiki will only consider the foreign repository if no file of the given name
550 * is found in the local repository (e.g. via `[[File:..]]` syntax).
553 * @see $wgLocalFileRepo
555 $wgForeignFileRepos = [];
558 * Use Wikimedia Commons as a foreign file repository.
560 * This is a shortcut for adding an entry to to $wgForeignFileRepos
561 * for https://commons.wikimedia.org, using ForeignAPIRepo with the
566 $wgUseInstantCommons = false;
569 * Shortcut for adding an entry to $wgForeignFileRepos.
571 * Uses the following variables:
573 * - directory: $wgSharedUploadDirectory.
574 * - url: $wgSharedUploadPath.
575 * - hashLevels: Based on $wgHashedSharedUploadDirectory.
576 * - thumbScriptUrl: $wgSharedThumbnailScriptPath.
577 * - transformVia404: Based on $wgGenerateThumbnailOnParse.
578 * - descBaseUrl: $wgRepositoryBaseUrl.
579 * - fetchDescription: $wgFetchCommonsDescriptions.
581 * If $wgSharedUploadDBname is set, it uses the ForeignDBRepo
582 * class, with also the following variables:
584 * - dbName: $wgSharedUploadDBname.
585 * - dbType: $wgDBtype.
586 * - dbServer: $wgDBserver.
587 * - dbUser: $wgDBuser.
588 * - dbPassword: $wgDBpassword.
589 * - dbFlags: Based on $wgDebugDumpSql.
590 * - tablePrefix: $wgSharedUploadDBprefix,
591 * - hasSharedCache: $wgCacheSharedUploads.
596 $wgUseSharedUploads = false;
599 * Shortcut for the 'directory' setting of $wgForeignFileRepos.
600 * Only used if $wgUseSharedUploads is enabled.
605 $wgSharedUploadDirectory = null;
608 * Shortcut for the 'url' setting of $wgForeignFileRepos.
609 * Only used if $wgUseSharedUploads is enabled.
614 $wgSharedUploadPath = null;
617 * Shortcut for the 'hashLevels' setting of $wgForeignFileRepos.
618 * Only used if $wgUseSharedUploads is enabled.
623 $wgHashedSharedUploadDirectory = true;
626 * Shortcut for the 'descBaseUrl' setting of $wgForeignFileRepos.
627 * Only used if $wgUseSharedUploads is enabled.
631 $wgRepositoryBaseUrl = 'https://commons.wikimedia.org/wiki/File:';
634 * Shortcut for the 'fetchDescription' setting of $wgForeignFileRepos.
635 * Only used if $wgUseSharedUploads is enabled.
640 $wgFetchCommonsDescriptions = false;
643 * Shortcut for the ForeignDBRepo 'dbName' setting in $wgForeignFileRepos.
644 * Set this to false if the uploads do not come from a wiki.
645 * Only used if $wgUseSharedUploads is enabled.
650 $wgSharedUploadDBname = false;
653 * Shortcut for the ForeignDBRepo 'tablePrefix' setting in $wgForeignFileRepos.
654 * Only used if $wgUseSharedUploads is enabled.
659 $wgSharedUploadDBprefix = '';
662 * Shortcut for the ForeignDBRepo 'hasSharedCache' setting in $wgForeignFileRepos.
663 * Only used if $wgUseSharedUploads is enabled.
668 $wgCacheSharedUploads = true;
671 * Array of foreign file repo names (set in $wgForeignFileRepos above) that
672 * are allowable upload targets. These wikis must have some method of
673 * authentication (i.e. CentralAuth), and be CORS-enabled for this wiki.
674 * The string 'local' signifies the default local file repository.
677 * $wgForeignUploadTargets = [ 'shared' ];
679 $wgForeignUploadTargets = [ 'local' ];
682 * Configuration for file uploads using the embeddable upload dialog
683 * (https://www.mediawiki.org/wiki/Upload_dialog).
685 * This applies also to foreign uploads to this wiki (the configuration is loaded by remote wikis
686 * using the action=query&meta=siteinfo API).
688 * See below for documentation of each property. None of the properties may be omitted.
691 // Fields to make available in the dialog. `true` means that this field is visible, `false` means
692 // that it is hidden. The "Name" field can't be hidden. Note that you also have to add the
693 // matching replacement to the 'filepage' format key below to make use of these.
695 'description' => true,
697 'categories' => false,
699 // Suffix of localisation messages used to describe the license under which the uploaded file will
700 // be released. The same value may be set for both 'local' and 'foreign' uploads.
701 'licensemessages' => [
702 // The 'local' messages are used for local uploads on this wiki:
703 // * upload-form-label-own-work-message-generic-local
704 // * upload-form-label-not-own-work-message-generic-local
705 // * upload-form-label-not-own-work-local-generic-local
706 'local' => 'generic-local',
707 // The 'foreign' messages are used for cross-wiki uploads from other wikis to this wiki:
708 // * upload-form-label-own-work-message-generic-foreign
709 // * upload-form-label-not-own-work-message-generic-foreign
710 // * upload-form-label-not-own-work-local-generic-foreign
711 'foreign' => 'generic-foreign',
713 // Upload comments to use for 'local' and 'foreign' uploads. This can also be set to a single
714 // string value, in which case it is used for both kinds of uploads. Available replacements:
715 // * $HOST - domain name from which a cross-wiki upload originates
716 // * $PAGENAME - wiki page name from which an upload originates
721 // Format of the file page wikitext to be generated from the fields input by the user.
723 // Wrapper for the whole page. Available replacements:
724 // * $DESCRIPTION - file description, as input by the user (only if the 'description' field is
725 // enabled), wrapped as defined below in the 'description' key
726 // * $DATE - file creation date, as input by the user (only if the 'date' field is enabled)
727 // * $SOURCE - as defined below in the 'ownwork' key, may be extended in the future
728 // * $AUTHOR - linked user name, may be extended in the future
729 // * $LICENSE - as defined below in the 'license' key, may be extended in the future
730 // * $CATEGORIES - file categories wikitext, as input by the user (only if the 'categories'
731 // field is enabled), or if no input, as defined below in the 'uncategorized' key
732 'filepage' => '$DESCRIPTION',
733 // Wrapped for file description. Available replacements:
734 // * $LANGUAGE - source wiki's content language
735 // * $TEXT - input by the user
736 'description' => '$TEXT',
739 'uncategorized' => '',
744 * File backend structure configuration.
746 * This is an array of file backend configuration arrays.
747 * Each backend configuration has the following parameters:
748 * - name : A unique name for the backend
749 * - class : The file backend class to use
750 * - wikiId : A unique string that identifies the wiki (container prefix)
751 * - lockManager : The name of a lock manager (see $wgLockManagers) [optional]
752 * - fileJournal : File journal configuration for FileJournal::__construct() [optional]
754 * See FileBackend::__construct() for more details.
755 * Additional parameters are specific to the file backend class used.
756 * These settings should be global to all wikis when possible.
758 * FileBackendMultiWrite::__construct() is augmented with a 'template' option that
759 * can be used in any of the values of the 'backends' array. Its value is the name of
760 * another backend in $wgFileBackends. When set, it pre-fills the array with all of the
761 * configuration of the named backend. Explicitly set values in the array take precedence.
763 * There are two particularly important aspects about each backend:
764 * - a) Whether it is fully qualified or wiki-relative.
765 * By default, the paths of files are relative to the current wiki,
766 * which works via prefixing them with the current wiki ID when accessed.
767 * Setting 'domainId' forces the backend to be fully qualified by prefixing
768 * all paths with the specified value instead. This can be useful if
769 * multiple wikis need to share the same data. Note that 'name' is *not*
770 * part of any prefix and thus should not be relied upon for namespacing.
771 * - b) Whether it is only defined for some wikis or is defined on all
772 * wikis in the wiki farm. Defining a backend globally is useful
773 * if multiple wikis need to share the same data.
774 * One should be aware of these aspects when configuring a backend for use with
775 * any basic feature or plugin. For example, suppose an extension stores data for
776 * different wikis in different directories and sometimes needs to access data from
777 * a foreign wiki's directory in order to render a page on given wiki. The extension
778 * would need a fully qualified backend that is defined on all wikis in the wiki farm.
780 $wgFileBackends = [];
783 * Array of configuration arrays for each lock manager.
784 * Each backend configuration has the following parameters:
785 * - name : A unique name for the lock manager
786 * - class : The lock manger class to use
788 * See LockManager::__construct() for more details.
789 * Additional parameters are specific to the lock manager class used.
790 * These settings should be global to all wikis.
792 $wgLockManagers = [];
795 * Show Exif data, on by default if available.
796 * Requires PHP's Exif extension: https://www.php.net/manual/en/ref.exif.php
798 * @note FOR WINDOWS USERS:
799 * To enable Exif functions, add the following line to the "Windows
800 * extensions" section of php.ini:
802 * extension=extensions/php_exif.dll
805 $wgShowEXIF = function_exists( 'exif_read_data' );
808 * If to automatically update the img_metadata field
809 * if the metadata field is outdated but compatible with the current version.
812 $wgUpdateCompatibleMetadata = false;
815 * Allow for upload to be copied from an URL.
816 * The timeout for copy uploads is set by $wgCopyUploadTimeout.
817 * You have to assign the user right 'upload_by_url' to a user group, to use this.
819 $wgAllowCopyUploads = false;
822 * A list of domains copy uploads can come from
826 $wgCopyUploadsDomains = [];
829 * Enable copy uploads from Special:Upload. $wgAllowCopyUploads must also be
830 * true. If $wgAllowCopyUploads is true, but this is false, you will only be
831 * able to perform copy uploads from the API or extensions (e.g. UploadWizard).
833 $wgCopyUploadsFromSpecialUpload = false;
836 * Proxy to use for copy upload requests.
839 $wgCopyUploadProxy = false;
842 * Different timeout for upload by url
843 * This could be useful since when fetching large files, you may want a
844 * timeout longer than the default $wgHTTPTimeout. False means fallback
851 $wgCopyUploadTimeout = false;
854 * Max size for uploads, in bytes. If not set to an array, applies to all
855 * uploads. If set to an array, per upload type maximums can be set, using the
856 * file and url keys. If the * key is set this value will be used as maximum
857 * for non-specified types.
861 * $wgMaxUploadSize = [
863 * 'url' => 500 * 1024,
866 * Sets the maximum for all uploads to 250 kB except for upload-by-url, which
867 * will have a maximum of 500 kB.
869 $wgMaxUploadSize = 1024 * 1024 * 100; # 100MB
872 * Minimum upload chunk size, in bytes. When using chunked upload, non-final
873 * chunks smaller than this will be rejected. May be reduced based on the
874 * 'upload_max_filesize' or 'post_max_size' PHP settings.
877 $wgMinUploadChunkSize = 1024; # 1KB
880 * Point the upload navigation link to an external URL
881 * Useful if you want to use a shared repository by default
882 * without disabling local uploads (use $wgEnableUploads = false for that).
886 * $wgUploadNavigationUrl = 'https://commons.wikimedia.org/wiki/Special:Upload';
889 $wgUploadNavigationUrl = false;
892 * Point the upload link for missing files to an external URL, as with
893 * $wgUploadNavigationUrl. The URL will get "(?|&)wpDestFile=<filename>"
894 * appended to it as appropriate.
896 $wgUploadMissingFileUrl = false;
899 * Give a path here to use thumb.php for thumbnail generation on client
900 * request, instead of generating them on render and outputting a static URL.
901 * This is necessary if some of your apache servers don't have read/write
902 * access to the thumbnail path.
906 * $wgThumbnailScriptPath = "{$wgScriptPath}/thumb.php";
909 $wgThumbnailScriptPath = false;
912 * Shortcut for the 'thumbScriptUrl' setting of $wgForeignFileRepos.
913 * Only used if $wgUseSharedUploads is enabled.
918 $wgSharedThumbnailScriptPath = false;
921 * Set this to false if you do not want MediaWiki to divide your images
922 * directory into many subdirectories, for improved performance.
924 * It's almost always good to leave this enabled. In previous versions of
925 * MediaWiki, some users set this to false to allow images to be added to the
926 * wiki by simply copying them into $wgUploadDirectory and then running
927 * maintenance/rebuildImages.php to register them in the database. This is no
928 * longer recommended, use maintenance/importImages.php instead.
930 * @note That this variable may be ignored if $wgLocalFileRepo is set.
931 * @todo Deprecate the setting and ultimately remove it from Core.
933 $wgHashedUploadDirectory = true;
936 * This is the list of preferred extensions for uploading files. Uploading files
937 * with extensions not in this list will trigger a warning.
939 * @warning If you add any OpenOffice or Microsoft Office file formats here,
940 * such as odt or doc, and untrusted users are allowed to upload files, then
941 * your wiki will be vulnerable to cross-site request forgery (CSRF).
943 $wgFileExtensions = [ 'png', 'gif', 'jpg', 'jpeg', 'webp' ];
946 * Files with these extensions will never be allowed as uploads.
947 * An array of file extensions to blacklist. You should append to this array
948 * if you want to blacklist additional files.
951 # HTML may contain cookie-stealing JavaScript and web bugs
952 'html', 'htm', 'js', 'jsb', 'mhtml', 'mht', 'xhtml', 'xht',
953 # PHP scripts may execute arbitrary code on the server
954 'php', 'phtml', 'php3', 'php4', 'php5', 'phps', 'phar',
955 # Other types that may be interpreted by some servers
956 'shtml', 'jhtml', 'pl', 'py', 'cgi',
957 # May contain harmful executables for Windows victims
958 'exe', 'scr', 'dll', 'msi', 'vbs', 'bat', 'com', 'pif', 'cmd', 'vxd', 'cpl' ];
961 * Files with these MIME types will never be allowed as uploads
962 * if $wgVerifyMimeType is enabled.
964 $wgMimeTypeBlacklist = [
965 # HTML may contain cookie-stealing JavaScript and web bugs
966 'text/html', 'text/javascript', 'text/x-javascript', 'application/x-shellscript',
967 # PHP scripts may execute arbitrary code on the server
968 'application/x-php', 'text/x-php',
969 # Other types that may be interpreted by some servers
970 'text/x-python', 'text/x-perl', 'text/x-bash', 'text/x-sh', 'text/x-csh',
971 # Client-side hazards on Internet Explorer
972 'text/scriptlet', 'application/x-msdownload',
973 # Windows metafile, client-side vulnerability on some systems
974 'application/x-msmetafile',
978 * Allow Java archive uploads.
979 * This is not recommended for public wikis since a maliciously-constructed
980 * applet running on the same domain as the wiki can steal the user's cookies.
982 $wgAllowJavaUploads = false;
985 * This is a flag to determine whether or not to check file extensions on upload.
987 * @warning Setting this to false is insecure for public wikis.
989 $wgCheckFileExtensions = true;
992 * If this is turned off, users may override the warning for files not covered
993 * by $wgFileExtensions.
995 * @warning Setting this to false is insecure for public wikis.
997 $wgStrictFileExtensions = true;
1000 * Setting this to true will disable the upload system's checks for HTML/JavaScript.
1002 * @warning THIS IS VERY DANGEROUS on a publicly editable site, so USE
1003 * $wgGroupPermissions TO RESTRICT UPLOADING to only those that you trust
1005 $wgDisableUploadScriptChecks = false;
1008 * Warn if uploaded files are larger than this (in bytes), or false to disable
1010 $wgUploadSizeWarning = false;
1013 * list of trusted media-types and MIME types.
1014 * Use the MEDIATYPE_xxx constants to represent media types.
1015 * This list is used by File::isSafeFile
1017 * Types not listed here will have a warning about unsafe content
1018 * displayed on the images description page. It would also be possible
1019 * to use this for further restrictions, like disabling direct
1020 * [[media:...]] links for non-trusted formats.
1022 $wgTrustedMediaFormats = [
1023 MEDIATYPE_BITMAP
, // all bitmap formats
1024 MEDIATYPE_AUDIO
, // all audio formats
1025 MEDIATYPE_VIDEO
, // all plain video formats
1026 "image/svg+xml", // svg (only needed if inline rendering of svg is not supported)
1027 "application/pdf", // PDF files
1028 # "application/x-shockwave-flash", //flash/shockwave movie
1032 * Plugins for media file type handling.
1033 * Each entry in the array maps a MIME type to a class name
1035 * Core media handlers are listed in MediaHandlerFactory,
1036 * and extensions should use extension.json.
1038 $wgMediaHandlers = [];
1041 * Media handler overrides for parser tests (they don't need to generate actual
1042 * thumbnails, so a mock will do)
1044 $wgParserTestMediaHandlers = [
1045 'image/jpeg' => 'MockBitmapHandler',
1046 'image/png' => 'MockBitmapHandler',
1047 'image/gif' => 'MockBitmapHandler',
1048 'image/tiff' => 'MockBitmapHandler',
1049 'image/webp' => 'MockBitmapHandler',
1050 'image/x-ms-bmp' => 'MockBitmapHandler',
1051 'image/x-bmp' => 'MockBitmapHandler',
1052 'image/x-xcf' => 'MockBitmapHandler',
1053 'image/svg+xml' => 'MockSvgHandler',
1054 'image/vnd.djvu' => 'MockDjVuHandler',
1058 * Plugins for page content model handling.
1059 * Each entry in the array maps a model id to a class name or callback
1060 * that creates an instance of the appropriate ContentHandler subclass.
1064 $wgContentHandlers = [
1066 CONTENT_MODEL_WIKITEXT
=> WikitextContentHandler
::class,
1067 // dumb version, no syntax highlighting
1068 CONTENT_MODEL_JAVASCRIPT
=> JavaScriptContentHandler
::class,
1069 // simple implementation, for use by extensions, etc.
1070 CONTENT_MODEL_JSON
=> JsonContentHandler
::class,
1071 // dumb version, no syntax highlighting
1072 CONTENT_MODEL_CSS
=> CssContentHandler
::class,
1073 // plain text, for use by extensions, etc.
1074 CONTENT_MODEL_TEXT
=> TextContentHandler
::class,
1078 * Whether to enable server-side image thumbnailing. If false, images will
1079 * always be sent to the client in full resolution, with appropriate width= and
1080 * height= attributes on the <img> tag for the client to do its own scaling.
1082 $wgUseImageResize = true;
1085 * Resizing can be done using PHP's internal image libraries or using
1086 * ImageMagick or another third-party converter, e.g. GraphicMagick.
1087 * These support more file formats than PHP, which only supports PNG,
1088 * GIF, JPG, XBM and WBMP.
1090 * Use Image Magick instead of PHP builtin functions.
1092 $wgUseImageMagick = false;
1095 * The convert command shipped with ImageMagick
1097 $wgImageMagickConvertCommand = '/usr/bin/convert';
1100 * Array of max pixel areas for interlacing per MIME type
1103 $wgMaxInterlacingAreas = [];
1106 * Sharpening parameter to ImageMagick
1108 $wgSharpenParameter = '0x0.4';
1111 * Reduction in linear dimensions below which sharpening will be enabled
1113 $wgSharpenReductionThreshold = 0.85;
1116 * Temporary directory used for ImageMagick. The directory must exist. Leave
1117 * this set to false to let ImageMagick decide for itself.
1119 $wgImageMagickTempDir = false;
1122 * Use another resizing converter, e.g. GraphicMagick
1123 * %s will be replaced with the source path, %d with the destination
1124 * %w and %h will be replaced with the width and height.
1126 * @par Example for GraphicMagick:
1128 * $wgCustomConvertCommand = "gm convert %s -resize %wx%h %d"
1131 * Leave as false to skip this.
1133 $wgCustomConvertCommand = false;
1136 * used for lossless jpeg rotation
1140 $wgJpegTran = '/usr/bin/jpegtran';
1143 * At default setting of 'yuv420', JPEG thumbnails will use 4:2:0 chroma
1144 * subsampling to reduce file size, at the cost of possible color fringing
1147 * See https://en.wikipedia.org/wiki/Chroma_subsampling
1150 * false - use scaling system's default (same as pre-1.27 behavior)
1151 * 'yuv444' - luma and chroma at same resolution
1152 * 'yuv422' - chroma at 1/2 resolution horizontally, full vertically
1153 * 'yuv420' - chroma at 1/2 resolution in both dimensions
1155 * This setting is currently supported only for the ImageMagick backend;
1156 * others may default to 4:2:0 or 4:4:4 or maintaining the source file's
1157 * sampling in the thumbnail.
1161 $wgJpegPixelFormat = 'yuv420';
1164 * When scaling a JPEG thumbnail, this is the quality we request
1165 * from the backend. It should be an int between 1 and 100,
1166 * with 100 indicating 100% quality.
1170 $wgJpegQuality = 80;
1173 * Some tests and extensions use exiv2 to manipulate the Exif metadata in some
1176 $wgExiv2Command = '/usr/bin/exiv2';
1179 * Path to exiftool binary. Used for lossless ICC profile swapping.
1183 $wgExiftool = '/usr/bin/exiftool';
1186 * Scalable Vector Graphics (SVG) may be uploaded as images.
1187 * Since SVG support is not yet standard in browsers, it is
1188 * necessary to rasterize SVGs to PNG as a fallback format.
1190 * An external program is required to perform this conversion.
1191 * If set to an array, the first item is a PHP callable and any further items
1192 * are passed as parameters after $srcPath, $dstPath, $width, $height
1194 $wgSVGConverters = [
1196 '$path/convert -background "#ffffff00" -thumbnail $widthx$height\! $input PNG:$output',
1197 'sodipodi' => '$path/sodipodi -z -w $width -f $input -e $output',
1198 'inkscape' => '$path/inkscape -z -w $width -f $input -e $output',
1199 'batik' => 'java -Djava.awt.headless=true -jar $path/batik-rasterizer.jar -w $width -d '
1201 'rsvg' => '$path/rsvg-convert -w $width -h $height -o $output $input',
1202 'imgserv' => '$path/imgserv-wrapper -i svg -o png -w$width $input $output',
1203 'ImagickExt' => [ 'SvgHandler::rasterizeImagickExt' ],
1207 * Pick a converter defined in $wgSVGConverters
1209 $wgSVGConverter = 'ImageMagick';
1212 * If not in the executable PATH, specify the SVG converter path.
1214 $wgSVGConverterPath = '';
1217 * Don't scale a SVG larger than this
1219 $wgSVGMaxSize = 5120;
1222 * Don't read SVG metadata beyond this point.
1223 * Default is 1024*256 bytes
1225 $wgSVGMetadataCutoff = 262144;
1228 * Obsolete, no longer used.
1229 * SVG file uploads now always allow <title> elements.
1233 $wgAllowTitlesInSVG = true;
1236 * Whether thumbnails should be generated in target language (usually, same as
1237 * page language), if available.
1238 * Currently, applies only to SVG images that use the systemLanguage attribute
1239 * to specify text language.
1243 $wgMediaInTargetLanguage = true;
1246 * The maximum number of pixels a source image can have if it is to be scaled
1247 * down by a scaler that requires the full source image to be decompressed
1248 * and stored in decompressed form, before the thumbnail is generated.
1250 * This provides a limit on memory usage for the decompression side of the
1251 * image scaler. The limit is used when scaling PNGs with any of the
1252 * built-in image scalers, such as ImageMagick or GD. It is ignored for
1253 * JPEGs with ImageMagick, and when using the VipsScaler extension.
1255 * The default is 50 MB if decompressed to RGBA form, which corresponds to
1256 * 12.5 million pixels or 3500x3500.
1258 $wgMaxImageArea = 1.25e7
;
1261 * Force thumbnailing of animated GIFs above this size to a single
1262 * frame instead of an animated thumbnail. As of MW 1.17 this limit
1263 * is checked against the total size of all frames in the animation.
1264 * It probably makes sense to keep this equal to $wgMaxImageArea.
1266 $wgMaxAnimatedGifArea = 1.25e7
;
1269 * Browsers don't support TIFF inline generally...
1270 * For inline display, we need to convert to PNG or JPEG.
1271 * Note scaling should work with ImageMagick, but may not with GD scaling.
1275 * // PNG is lossless, but inefficient for photos
1276 * $wgTiffThumbnailType = [ 'png', 'image/png' ];
1277 * // JPEG is good for photos, but has no transparency support. Bad for diagrams.
1278 * $wgTiffThumbnailType = [ 'jpg', 'image/jpeg' ];
1281 $wgTiffThumbnailType = [];
1284 * If rendered thumbnail files are older than this timestamp, they
1285 * will be rerendered on demand as if the file didn't already exist.
1286 * Update if there is some need to force thumbs and SVG rasterizations
1287 * to rerender, such as fixes to rendering bugs.
1289 $wgThumbnailEpoch = '20030516000000';
1292 * Certain operations are avoided if there were too many recent failures,
1293 * for example, thumbnail generation. Bump this value to invalidate all
1294 * memory of failed operations and thus allow further attempts to resume.
1295 * This is useful when a cause for the failures has been found and fixed.
1297 $wgAttemptFailureEpoch = 1;
1300 * If set, inline scaled images will still produce "<img>" tags ready for
1301 * output instead of showing an error message.
1303 * This may be useful if errors are transitory, especially if the site
1304 * is configured to automatically render thumbnails on request.
1306 * On the other hand, it may obscure error conditions from debugging.
1307 * Enable the debug log or the 'thumbnail' log group to make sure errors
1308 * are logged to a file for review.
1310 $wgIgnoreImageErrors = false;
1313 * Allow thumbnail rendering on page view. If this is false, a valid
1314 * thumbnail URL is still output, but no file will be created at
1315 * the target location. This may save some time if you have a
1316 * thumb.php or 404 handler set up which is faster than the regular
1319 $wgGenerateThumbnailOnParse = true;
1322 * Show thumbnails for old images on the image description page
1324 $wgShowArchiveThumbnails = true;
1327 * If set to true, images that contain certain the exif orientation tag will
1328 * be rotated accordingly. If set to null, try to auto-detect whether a scaler
1329 * is available that can rotate.
1331 $wgEnableAutoRotation = null;
1334 * Internal name of virus scanner. This serves as a key to the
1335 * $wgAntivirusSetup array. Set this to NULL to disable virus scanning. If not
1336 * null, every file uploaded will be scanned for viruses.
1338 $wgAntivirus = null;
1341 * Configuration for different virus scanners. This an associative array of
1342 * associative arrays. It contains one setup array per known scanner type.
1343 * The entry is selected by $wgAntivirus, i.e.
1344 * valid values for $wgAntivirus are the keys defined in this array.
1346 * The configuration array for each scanner contains the following keys:
1347 * "command", "codemap", "messagepattern":
1349 * "command" is the full command to call the virus scanner - %f will be
1350 * replaced with the name of the file to scan. If not present, the filename
1351 * will be appended to the command. Note that this must be overwritten if the
1352 * scanner is not in the system path; in that case, please set
1353 * $wgAntivirusSetup[$wgAntivirus]['command'] to the desired command with full
1356 * "codemap" is a mapping of exit code to return codes of the detectVirus
1357 * function in SpecialUpload.
1358 * - An exit code mapped to AV_SCAN_FAILED causes the function to consider
1359 * the scan to be failed. This will pass the file if $wgAntivirusRequired
1361 * - An exit code mapped to AV_SCAN_ABORTED causes the function to consider
1362 * the file to have an unsupported format, which is probably immune to
1363 * viruses. This causes the file to pass.
1364 * - An exit code mapped to AV_NO_VIRUS will cause the file to pass, meaning
1365 * no virus was found.
1366 * - All other codes (like AV_VIRUS_FOUND) will cause the function to report
1368 * - You may use "*" as a key in the array to catch all exit codes not mapped otherwise.
1370 * "messagepattern" is a perl regular expression to extract the meaningful part of the scanners
1371 * output. The relevant part should be matched as group one (\1).
1372 * If not defined or the pattern does not match, the full message is shown to the user.
1374 $wgAntivirusSetup = [
1378 'command' => 'clamscan --no-summary ',
1380 "0" => AV_NO_VIRUS
, # no virus
1381 "1" => AV_VIRUS_FOUND
, # virus found
1382 "52" => AV_SCAN_ABORTED
, # unsupported file format (probably immune)
1383 "*" => AV_SCAN_FAILED
, # else scan failed
1385 'messagepattern' => '/.*?:(.*)/sim',
1390 * Determines if a failed virus scan (AV_SCAN_FAILED) will cause the file to be rejected.
1392 $wgAntivirusRequired = true;
1395 * Determines if the MIME type of uploaded files should be checked
1397 $wgVerifyMimeType = true;
1400 * Determines whether extra checks for IE type detection should be applied.
1401 * This is a conservative check for exactly what IE 6 or so checked for,
1402 * and shouldn't trigger on for instance JPEG files containing links in EXIF
1407 $wgVerifyMimeTypeIE = true;
1410 * Sets the MIME type definition file to use by includes/libs/mime/MimeAnalyzer.php.
1411 * Set to null, to use built-in defaults only.
1412 * example: $wgMimeTypeFile = '/etc/mime.types';
1414 $wgMimeTypeFile = 'includes/mime.types';
1417 * Sets the MIME type info file to use by includes/libs/mime/MimeAnalyzer.php.
1418 * Set to null, to use built-in defaults only.
1420 $wgMimeInfoFile = 'includes/mime.info';
1423 * Sets an external MIME detector program. The command must print only
1424 * the MIME type to standard output.
1425 * The name of the file to process will be appended to the command given here.
1426 * If not set or NULL, PHP's mime_content_type function will be used.
1430 * #$wgMimeDetectorCommand = "file -bi"; # use external MIME detector (Linux)
1433 $wgMimeDetectorCommand = null;
1436 * Switch for trivial MIME detection. Used by thumb.php to disable all fancy
1437 * things, because only a few types of images are needed and file extensions
1440 $wgTrivialMimeDetection = false;
1443 * Additional XML types we can allow via MIME-detection.
1444 * array = [ 'rootElement' => 'associatedMimeType' ]
1447 'http://www.w3.org/2000/svg:svg' => 'image/svg+xml',
1448 'svg' => 'image/svg+xml',
1449 'http://www.lysator.liu.se/~alla/dia/:diagram' => 'application/x-dia-diagram',
1450 'http://www.w3.org/1999/xhtml:html' => 'text/html', // application/xhtml+xml?
1451 'html' => 'text/html', // application/xhtml+xml?
1455 * Limit images on image description pages to a user-selectable limit. In order
1456 * to reduce disk usage, limits can only be selected from a list.
1457 * The user preference is saved as an array offset in the database, by default
1458 * the offset is set with $wgDefaultUserOptions['imagesize']. Make sure you
1459 * change it if you alter the array (see T10858).
1460 * This is the list of settings the user can choose from:
1471 * Adjust thumbnails on image pages according to a user setting. In order to
1472 * reduce disk usage, the values can only be selected from a list. This is the
1473 * list of settings the user can choose from:
1485 * When defined, is an array of image widths used as buckets for thumbnail generation.
1486 * The goal is to save resources by generating thumbnails based on reference buckets instead of
1487 * always using the original. This will incur a speed gain but cause a quality loss.
1489 * The buckets generation is chained, with each bucket generated based on the above bucket
1490 * when possible. File handlers have to opt into using that feature. For now only BitmapHandler
1493 $wgThumbnailBuckets = null;
1496 * When using thumbnail buckets as defined above, this sets the minimum distance to the bucket
1497 * above the requested size. The distance represents how many extra pixels of width the bucket
1498 * needs in order to be used as the reference for a given thumbnail. For example, with the
1499 * following buckets:
1501 * $wgThumbnailBuckets = [ 128, 256, 512 ];
1503 * and a distance of 50:
1505 * $wgThumbnailMinimumBucketDistance = 50;
1507 * If we want to render a thumbnail of width 220px, the 512px bucket will be used,
1508 * because 220 + 50 = 270 and the closest bucket bigger than 270px is 512.
1510 $wgThumbnailMinimumBucketDistance = 50;
1513 * When defined, is an array of thumbnail widths to be rendered at upload time. The idea is to
1514 * prerender common thumbnail sizes, in order to avoid the necessity to render them on demand, which
1515 * has a performance impact for the first client to view a certain size.
1517 * This obviously means that more disk space is needed per upload upfront.
1522 $wgUploadThumbnailRenderMap = [];
1525 * The method through which the thumbnails will be prerendered for the entries in
1526 * $wgUploadThumbnailRenderMap
1528 * The method can be either "http" or "jobqueue". The former uses an http request to hit the
1530 * This method only works if thumbnails are configured to be rendered by a 404 handler. The latter
1531 * option uses the job queue to render the thumbnail.
1535 $wgUploadThumbnailRenderMethod = 'jobqueue';
1538 * When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom Host HTTP header.
1542 $wgUploadThumbnailRenderHttpCustomHost = false;
1545 * When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom domain to send the
1550 $wgUploadThumbnailRenderHttpCustomDomain = false;
1553 * When this variable is true and JPGs use the sRGB ICC profile, swaps it for the more lightweight
1554 * (and free) TinyRGB profile when generating thumbnails.
1558 $wgUseTinyRGBForJPGThumbnails = false;
1561 * Parameters for the "<gallery>" tag.
1563 * - imagesPerRow: Default number of images per-row in the gallery. 0 -> Adapt to screensize
1564 * - imageWidth: Width of the cells containing images in galleries (in "px")
1565 * - imageHeight: Height of the cells containing images in galleries (in "px")
1566 * - captionLength: Length to truncate filename to in caption when using "showfilename".
1567 * A value of 'true' will truncate the filename to one line using CSS
1568 * and will be the behaviour after deprecation.
1569 * @deprecated since 1.28
1570 * - showBytes: Show the filesize in bytes in categories
1571 * - showDimensions: Show the dimensions (width x height) in categories
1572 * - mode: Gallery mode
1574 $wgGalleryOptions = [];
1577 * Adjust width of upright images when parameter 'upright' is used
1578 * This allows a nicer look for upright images without the need to fix the width
1579 * by hardcoded px in wiki sourcecode.
1581 $wgThumbUpright = 0.75;
1584 * Default value for chmoding of new directories.
1586 $wgDirectoryMode = 0777;
1589 * Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities.
1591 * This means a 320x240 use of an image on the wiki will also generate 480x360 and 640x480
1592 * thumbnails, output via the srcset attribute.
1594 $wgResponsiveImages = true;
1597 * @name DJVU settings
1602 * Path of the djvudump executable
1603 * Enable this and $wgDjvuRenderer to enable djvu rendering
1604 * example: $wgDjvuDump = 'djvudump';
1609 * Path of the ddjvu DJVU renderer
1610 * Enable this and $wgDjvuDump to enable djvu rendering
1611 * example: $wgDjvuRenderer = 'ddjvu';
1613 $wgDjvuRenderer = null;
1616 * Path of the djvutxt DJVU text extraction utility
1617 * Enable this and $wgDjvuDump to enable text layer extraction from djvu files
1618 * example: $wgDjvuTxt = 'djvutxt';
1623 * Path of the djvutoxml executable
1624 * This works like djvudump except much, much slower as of version 3.5.
1626 * For now we recommend you use djvudump instead. The djvuxml output is
1627 * probably more stable, so we'll switch back to it as soon as they fix
1628 * the efficiency problem.
1629 * https://sourceforge.net/tracker/index.php?func=detail&aid=1704049&group_id=32953&atid=406583
1633 * $wgDjvuToXML = 'djvutoxml';
1636 $wgDjvuToXML = null;
1639 * Shell command for the DJVU post processor
1640 * Default: pnmtojpeg, since ddjvu generates ppm output
1641 * Set this to false to output the ppm file directly.
1643 $wgDjvuPostProcessor = 'pnmtojpeg';
1646 * File extension for the DJVU post processor output
1648 $wgDjvuOutputExtension = 'jpg';
1650 /** @} */ # end of DJvu }
1652 /** @} */ # end of file uploads }
1654 /************************************************************************//**
1655 * @name Email settings
1660 * Site admin email address.
1662 * Defaults to "wikiadmin@$wgServerName" (in Setup.php).
1664 $wgEmergencyContact = false;
1667 * Sender email address for e-mail notifications.
1669 * The address we use as sender when a user requests a password reminder,
1670 * as well as other e-mail notifications.
1672 * Defaults to "apache@$wgServerName" (in Setup.php).
1674 $wgPasswordSender = false;
1677 * Reply-To address for e-mail notifications.
1679 * Defaults to $wgPasswordSender (in Setup.php).
1681 $wgNoReplyAddress = false;
1684 * Set to true to enable the e-mail basic features:
1685 * Password reminders, etc. If sending e-mail on your
1686 * server doesn't work, you might want to disable this.
1688 $wgEnableEmail = true;
1691 * Set to true to enable user-to-user e-mail.
1692 * This can potentially be abused, as it's hard to track.
1694 $wgEnableUserEmail = true;
1697 * Set to true to enable the Special Mute page. This allows users
1698 * to mute unwanted communications from other users, and is linked
1699 * to from emails originating from Special:Email.
1704 $wgEnableSpecialMute = false;
1707 * Set to true to enable user-to-user e-mail blacklist.
1711 $wgEnableUserEmailBlacklist = false;
1714 * If true put the sending user's email in a Reply-To header
1715 * instead of From (false). ($wgPasswordSender will be used as From.)
1717 * Some mailers (eg SMTP) set the SMTP envelope sender to the From value,
1718 * which can cause problems with SPF validation and leak recipient addresses
1719 * when bounces are sent to the sender. In addition, DMARC restrictions
1720 * can cause emails to fail to be received when false.
1722 $wgUserEmailUseReplyTo = true;
1725 * Minimum time, in hours, which must elapse between password reminder
1726 * emails for a given account. This is to prevent abuse by mail flooding.
1728 $wgPasswordReminderResendTime = 24;
1731 * The time, in seconds, when an emailed temporary password expires.
1733 $wgNewPasswordExpiry = 3600 * 24 * 7;
1736 * The time, in seconds, when an email confirmation email expires
1738 $wgUserEmailConfirmationTokenExpiry = 7 * 24 * 60 * 60;
1741 * The number of days that a user's password is good for. After this number of days, the
1742 * user will be asked to reset their password. Set to false to disable password expiration.
1744 $wgPasswordExpirationDays = false;
1747 * If a user's password is expired, the number of seconds when they can still login,
1748 * and cancel their password change, but are sent to the password change form on each login.
1750 $wgPasswordExpireGrace = 3600 * 24 * 7; // 7 days
1755 * For using a direct (authenticated) SMTP server connection.
1756 * Default to false or fill an array :
1760 * 'host' => 'SMTP domain',
1761 * 'IDHost' => 'domain for MessageID',
1763 * 'auth' => [true|false],
1764 * 'username' => [SMTP username],
1765 * 'password' => [SMTP password],
1772 * Additional email parameters, will be passed as the last argument to mail() call.
1774 $wgAdditionalMailParams = null;
1777 * For parts of the system that have been updated to provide HTML email content, send
1778 * both text and HTML parts as the body of the email
1780 $wgAllowHTMLEmail = false;
1783 * Allow sending of e-mail notifications with the editor's address as sender.
1785 * This setting depends on $wgEnotifRevealEditorAddress also being enabled.
1786 * If both are enabled, notifications for actions from users that have opted-in,
1787 * will be sent to other users with their address as "From" instead of "Reply-To".
1789 * If disabled, or not opted-in, notifications come from $wgPasswordSender.
1793 $wgEnotifFromEditor = false;
1795 // TODO move UPO to preferences probably ?
1796 # If set to true, users get a corresponding option in their preferences and can choose to
1797 # enable or disable at their discretion
1798 # If set to false, the corresponding input form on the user preference page is suppressed
1799 # It call this to be a "user-preferences-option (UPO)"
1802 * Require email authentication before sending mail to an email address.
1803 * This is highly recommended. It prevents MediaWiki from being used as an open
1806 $wgEmailAuthentication = true;
1809 * Allow users to enable email notification ("enotif") on watchlist changes.
1811 $wgEnotifWatchlist = false;
1814 * Allow users to enable email notification ("enotif") when someone edits their
1817 * The owner of the user talk page must also have the 'enotifusertalkpages' user
1818 * preference set to true.
1820 $wgEnotifUserTalk = false;
1823 * Allow sending of e-mail notifications with the editor's address in "Reply-To".
1825 * Note, enabling this only actually uses it in notification e-mails if the user
1826 * opted-in to this feature. This feature flag also controls visibility of the
1827 * 'enotifrevealaddr' preference, which, if users opt into, will make e-mail
1828 * notifications about their actions use their address as "Reply-To".
1830 * To set the address as "From" instead of "Reply-To", also enable $wgEnotifFromEditor.
1832 * If disabled, or not opted-in, notifications come from $wgPasswordSender.
1836 $wgEnotifRevealEditorAddress = false;
1839 * Potentially send notification mails on minor edits to pages. This is enabled
1840 * by default. If this is false, users will never be notified on minor edits.
1842 * If it is true, editors with the 'nominornewtalk' right (typically bots) will still not
1843 * trigger notifications for minor edits they make (to any page, not just user talk).
1845 * Finally, if the watcher/recipient has the 'enotifminoredits' user preference set to
1846 * false, they will not receive notifications for minor edits.
1848 * User talk notifications are also affected by $wgEnotifMinorEdits, the above settings,
1849 * $wgEnotifUserTalk, and the preference described there.
1851 $wgEnotifMinorEdits = true;
1854 * Send a generic mail instead of a personalised mail for each user. This
1855 * always uses UTC as the time zone, and doesn't include the username.
1857 * For pages with many users watching, this can significantly reduce mail load.
1858 * Has no effect when using sendmail rather than SMTP.
1860 $wgEnotifImpersonal = false;
1863 * Maximum number of users to mail at once when using impersonal mail. Should
1864 * match the limit on your mail server.
1866 $wgEnotifMaxRecips = 500;
1869 * Use real name instead of username in e-mail "from" field.
1871 $wgEnotifUseRealName = false;
1874 * Array of usernames who will be sent a notification email for every change
1875 * which occurs on a wiki. Users will not be notified of their own changes.
1877 $wgUsersNotifiedOnAllChanges = [];
1879 /** @} */ # end of email settings
1881 /************************************************************************//**
1882 * @name Database settings
1887 * Current wiki database name
1889 * Should be alphanumeric, without spaces nor hyphens.
1890 * This is used to determine the current/local wiki ID (WikiMap::getCurrentWikiDbDomain).
1892 * This should still be set even if $wgLBFactoryConf is configured.
1894 $wgDBname = 'my_wiki';
1897 * Current wiki database schema name
1899 * Should be alphanumeric, without spaces nor hyphens.
1900 * This is used to determine the current/local wiki ID (WikiMap::getCurrentWikiDbDomain).
1902 * This should still be set even if $wgLBFactoryConf is configured.
1904 $wgDBmwschema = null;
1907 * Current wiki database table name prefix
1909 * Should be alphanumeric, without spaces nor hyphens, preferably ending in an underscore.
1910 * This is used to determine the current/local wiki ID (WikiMap::getCurrentWikiDbDomain).
1912 * This should still be set even if $wgLBFactoryConf is configured.
1917 * Database host name or IP address
1919 $wgDBserver = 'localhost';
1922 * Database port number (for PostgreSQL and Microsoft SQL Server).
1929 $wgDBuser = 'wikiuser';
1932 * Database user's password
1939 $wgDBtype = 'mysql';
1942 * Whether to use SSL in DB connection.
1944 * This setting is only used if $wgLBFactoryConf['class'] is set to
1945 * '\Wikimedia\Rdbms\LBFactorySimple' and $wgDBservers is an empty array; otherwise
1946 * the DBO_SSL flag must be set in the 'flags' option of the database
1947 * connection to achieve the same functionality.
1952 * Whether to use compression in DB connection.
1954 * This setting is only used $wgLBFactoryConf['class'] is set to
1955 * '\Wikimedia\Rdbms\LBFactorySimple' and $wgDBservers is an empty array; otherwise
1956 * the DBO_COMPRESS flag must be set in the 'flags' option of the database
1957 * connection to achieve the same functionality.
1959 $wgDBcompress = false;
1962 * Separate username for maintenance tasks. Leave as null to use the default.
1964 $wgDBadminuser = null;
1967 * Separate password for maintenance tasks. Leave as null to use the default.
1969 $wgDBadminpassword = null;
1973 * Leave as null to select the default search engine for the
1974 * selected database type (eg SearchMySQL), or set to a class
1975 * name to override to a custom search engine.
1977 $wgSearchType = null;
1980 * Alternative search types
1981 * Sometimes you want to support multiple search engines for testing. This
1982 * allows users to select their search engine of choice via url parameters
1983 * to Special:Search and the action=search API. If using this, there's no
1984 * need to add $wgSearchType to it, that is handled automatically.
1986 $wgSearchTypeAlternatives = null;
1989 * MySQL table options to use during installation or update
1991 $wgDBTableOptions = 'ENGINE=InnoDB, DEFAULT CHARSET=binary';
1994 * SQL Mode - default is turning off all modes, including strict, if set.
1995 * null can be used to skip the setting for performance reasons and assume
1996 * DBA has done his best job.
1997 * String override can be used for some additional fun :-)
2002 * Default group to use when getting database connections.
2003 * Will be used as default query group in ILoadBalancer::getConnection.
2006 $wgDBDefaultGroup = null;
2009 * To override default SQLite data directory ($docroot/../data)
2011 $wgSQLiteDataDir = '';
2014 * Shared database for multiple wikis. Commonly used for storing a user table
2015 * for single sign-on. The server for this database must be the same as for the
2018 * For backwards compatibility the shared prefix is set to the same as the local
2019 * prefix, and the user table is listed in the default list of shared tables.
2020 * The user_properties table is also added so that users will continue to have their
2021 * preferences shared (preferences were stored in the user table prior to 1.16)
2023 * $wgSharedTables may be customized with a list of tables to share in the shared
2024 * database. However it is advised to limit what tables you do share as many of
2025 * MediaWiki's tables may have side effects if you try to share them.
2027 * $wgSharedPrefix is the table prefix for the shared database. It defaults to
2030 * $wgSharedSchema is the table schema for the shared database. It defaults to
2033 * @deprecated since 1.21 In new code, use the $wiki parameter to LBFactory::getMainLB() to
2034 * access remote databases. Using LBFactory::getMainLB() allows the shared database to
2035 * reside on separate servers to the wiki's own database, with suitable
2036 * configuration of $wgLBFactoryConf.
2043 $wgSharedPrefix = false;
2048 $wgSharedTables = [ 'user', 'user_properties' ];
2054 $wgSharedSchema = false;
2057 * Database load balancer
2058 * This is a two-dimensional array, an array of server info structures
2061 * - dbname: Default database name
2063 * - password: DB password
2065 * - driver: DB driver (when there are multiple drivers)
2067 * - load: Ratio of DB_REPLICA load, must be >=0, the sum of all loads must be >0.
2068 * If this is zero for any given server, no normal query traffic will be
2069 * sent to it. It will be excluded from lag checks in maintenance scripts.
2070 * The only way it can receive traffic is if groupLoads is used.
2072 * - groupLoads: (optional) Array of load ratios, the key is the query group name. A query
2073 * may belong to several groups, the most specific group defined here is used.
2075 * - flags: (optional) Bit field of properties:
2076 * - DBO_DEFAULT: Transactionalize web requests and use autocommit otherwise
2077 * - DBO_DEBUG: Equivalent of $wgDebugDumpSql
2078 * - DBO_SSL: Use TLS connection encryption if available
2079 * - DBO_COMPRESS: Use protocol compression with database connections
2080 * - DBO_PERSISTENT: Enables persistent database connections
2082 * - max lag: (optional) Maximum replication lag before a replica DB goes out of rotation
2083 * - is static: (optional) Set to true if the dataset is static and no replication is used.
2084 * - cliMode: (optional) Connection handles will not assume that requests are short-lived
2085 * nor that INSERT..SELECT can be rewritten into a buffered SELECT and INSERT.
2086 * This is what DBO_DEFAULT uses to determine when a web request is present.
2087 * [Default: uses value of $wgCommandLineMode]
2089 * These and any other user-defined properties will be assigned to the mLBInfo member
2090 * variable of the Database object.
2092 * Leave at false to use the single-server variables above. If you set this
2093 * variable, the single-server variables will generally be ignored (except
2094 * perhaps in some command-line scripts).
2096 * The first server listed in this array (with key 0) will be the master. The
2097 * rest of the servers will be replica DBs. To prevent writes to your replica DBs due to
2098 * accidental misconfiguration or MediaWiki bugs, set read_only=1 on all your
2099 * replica DBs in my.cnf. You can set read_only mode at runtime using:
2102 * SET @@read_only=1;
2105 * Since the effect of writing to a replica DB is so damaging and difficult to clean
2106 * up, we at Wikimedia set read_only=1 in my.cnf on all our DB servers, even
2107 * our masters, and then set read_only=0 on masters at runtime.
2109 $wgDBservers = false;
2112 * Load balancer factory configuration
2113 * To set up a multi-master wiki farm, set the class here to something that
2114 * can return a LoadBalancer with an appropriate master on a call to getMainLB().
2115 * The class identified here is responsible for reading $wgDBservers,
2116 * $wgDBserver, etc., so overriding it may cause those globals to be ignored.
2118 * The LBFactoryMulti class is provided for this purpose, please see
2119 * includes/db/LBFactoryMulti.php for configuration information.
2121 $wgLBFactoryConf = [ 'class' => \Wikimedia\Rdbms\LBFactorySimple
::class ];
2124 * After a state-changing request is done by a client, this determines
2125 * how many seconds that client should keep using the master datacenter.
2126 * This avoids unexpected stale or 404 responses due to replication lag.
2129 $wgDataCenterUpdateStickTTL = 10;
2132 * File to log database errors to
2134 $wgDBerrorLog = false;
2137 * Timezone to use in the error log.
2138 * Defaults to the wiki timezone ($wgLocaltimezone).
2140 * A list of usable timezones can found at:
2141 * https://www.php.net/manual/en/timezones.php
2145 * $wgDBerrorLogTZ = 'UTC';
2146 * $wgDBerrorLogTZ = 'GMT';
2147 * $wgDBerrorLogTZ = 'PST8PDT';
2148 * $wgDBerrorLogTZ = 'Europe/Sweden';
2149 * $wgDBerrorLogTZ = 'CET';
2154 $wgDBerrorLogTZ = false;
2157 * Other wikis on this site, can be administered from a single developer account.
2159 * @var string[] List of wiki DB domain IDs; the format of each ID consist of 1-3 hyphen
2160 * delimited alphanumeric components (each with no hyphens nor spaces) of any of the forms:
2161 * - "<DB NAME>-<DB SCHEMA>-<TABLE PREFIX>"
2162 * - "<DB NAME>-<TABLE PREFIX>"
2164 * If hyphens appear in any of the components, then the domain ID parsing may not work
2165 * in all cases and site functionality might be affected. If the schema ($wgDBmwschema)
2166 * is left to the default "mediawiki" for all wikis, then the schema should be omitted
2169 $wgLocalDatabases = [];
2172 * If lag is higher than $wgSlaveLagWarning, show a warning in some special
2173 * pages (like watchlist). If the lag is higher than $wgSlaveLagCritical,
2174 * show a more obvious warning.
2176 $wgSlaveLagWarning = 10;
2179 * @see $wgSlaveLagWarning
2181 $wgSlaveLagCritical = 30;
2184 * Use Windows Authentication instead of $wgDBuser / $wgDBpassword for MS SQL Server
2186 $wgDBWindowsAuthentication = false;
2188 /** @} */ # End of DB settings }
2190 /************************************************************************//**
2191 * @name Text storage
2196 * We can also compress text stored in the 'text' table. If this is set on, new
2197 * revisions will be compressed on page save if zlib support is available. Any
2198 * compressed revisions will be decompressed on load regardless of this setting,
2199 * but will not be readable at all* if zlib support is not available.
2201 $wgCompressRevisions = false;
2204 * External stores allow including content
2205 * from non database sources following URL links.
2207 * Short names of ExternalStore classes may be specified in an array here:
2209 * $wgExternalStores = [ "http","file","custom" ]...
2212 * CAUTION: Access to database might lead to code execution
2214 $wgExternalStores = [];
2217 * An array of external MySQL servers.
2220 * Create a cluster named 'cluster1' containing three servers:
2222 * $wgExternalServers = [
2223 * 'cluster1' => <array in the same format as $wgDBservers>
2227 * Used by \Wikimedia\Rdbms\LBFactorySimple, may be ignored if $wgLBFactoryConf is set to
2230 $wgExternalServers = [];
2233 * The place to put new revisions, false to put them in the local text table.
2234 * Part of a URL, e.g. DB://cluster1
2236 * Can be an array instead of a single string, to enable data distribution. Keys
2237 * must be consecutive integers, starting at zero.
2241 * $wgDefaultExternalStore = [ 'DB://cluster1', 'DB://cluster2' ];
2246 $wgDefaultExternalStore = false;
2249 * Revision text may be cached in $wgMemc to reduce load on external storage
2250 * servers and object extraction overhead for frequently-loaded revisions.
2252 * Set to 0 to disable, or number of seconds before cache expiry.
2254 $wgRevisionCacheExpiry = 86400 * 7;
2256 /** @} */ # end text storage }
2258 /************************************************************************//**
2259 * @name Performance hacks and limits
2264 * Disable database-intensive features
2266 $wgMiserMode = false;
2269 * Disable all query pages if miser mode is on, not just some
2271 $wgDisableQueryPages = false;
2274 * Number of rows to cache in 'querycache' table when miser mode is on
2276 $wgQueryCacheLimit = 1000;
2279 * Number of links to a page required before it is deemed "wanted"
2281 $wgWantedPagesThreshold = 1;
2284 * Enable slow parser functions
2286 $wgAllowSlowParserFunctions = false;
2289 * Allow schema updates
2291 $wgAllowSchemaUpdates = true;
2294 * Maximum article size in kilobytes
2296 $wgMaxArticleSize = 2048;
2299 * The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to
2300 * raise PHP's memory limit if it's below this amount.
2302 $wgMemoryLimit = "50M";
2305 * The minimum amount of time that MediaWiki needs for "slow" write request,
2306 * particularly ones with multiple non-atomic writes that *should* be as
2307 * transactional as possible; MediaWiki will call set_time_limit() if needed.
2310 $wgTransactionalTimeLimit = 120;
2312 /** @} */ # end performance hacks }
2314 /************************************************************************//**
2315 * @name Cache settings
2320 * Directory for caching data in the local filesystem. Should not be accessible
2323 * Note: if multiple wikis share the same localisation cache directory, they
2324 * must all have the same set of extensions. You can set a directory just for
2325 * the localisation cache using $wgLocalisationCacheConf['storeDirectory'].
2327 $wgCacheDirectory = false;
2330 * Main cache type. This should be a cache with fast access, but it may have
2331 * limited space. By default, it is disabled, since the stock database cache
2332 * is not fast enough to make it worthwhile.
2336 * - CACHE_ANYTHING: Use anything, as long as it works
2337 * - CACHE_NONE: Do not cache
2338 * - CACHE_DB: Store cache objects in the DB
2339 * - CACHE_MEMCACHED: MemCached, must specify servers in $wgMemCachedServers
2340 * - CACHE_ACCEL: APC, APCU or WinCache
2341 * - (other): A string may be used which identifies a cache
2342 * configuration in $wgObjectCaches.
2344 * @see $wgMessageCacheType, $wgParserCacheType
2346 $wgMainCacheType = CACHE_NONE
;
2349 * The cache type for storing the contents of the MediaWiki namespace. This
2350 * cache is used for a small amount of data which is expensive to regenerate.
2352 * For available types see $wgMainCacheType.
2354 $wgMessageCacheType = CACHE_ANYTHING
;
2357 * The cache type for storing article HTML. This is used to store data which
2358 * is expensive to regenerate, and benefits from having plenty of storage space.
2360 * For available types see $wgMainCacheType.
2362 $wgParserCacheType = CACHE_ANYTHING
;
2365 * The cache type for storing session data.
2367 * For available types see $wgMainCacheType.
2369 $wgSessionCacheType = CACHE_ANYTHING
;
2372 * The cache type for storing language conversion tables,
2373 * which are used when parsing certain text and interface messages.
2375 * For available types see $wgMainCacheType.
2379 $wgLanguageConverterCacheType = CACHE_ANYTHING
;
2382 * Advanced object cache configuration.
2384 * Use this to define the class names and constructor parameters which are used
2385 * for the various cache types. Custom cache types may be defined here and
2386 * referenced from $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType,
2387 * or $wgLanguageConverterCacheType.
2389 * The format is an associative array where the key is a cache identifier, and
2390 * the value is an associative array of parameters. The "class" parameter is the
2391 * class name which will be used. Alternatively, a "factory" parameter may be
2392 * given, giving a callable function which will generate a suitable cache object.
2395 CACHE_NONE
=> [ 'class' => EmptyBagOStuff
::class, 'reportDupes' => false ],
2396 CACHE_DB
=> [ 'class' => SqlBagOStuff
::class, 'loggroup' => 'SQLBagOStuff' ],
2398 CACHE_ANYTHING
=> [ 'factory' => 'ObjectCache::newAnything' ],
2399 CACHE_ACCEL
=> [ 'factory' => 'ObjectCache::getLocalServerInstance' ],
2400 CACHE_MEMCACHED
=> [ 'class' => MemcachedPhpBagOStuff
::class, 'loggroup' => 'memcached' ],
2402 'db-replicated' => [
2403 'class' => ReplicatedBagOStuff
::class,
2405 'class' => SqlBagOStuff
::class,
2406 'args' => [ [ 'replicaOnly' => true ] ]
2409 'class' => SqlBagOStuff
::class,
2410 'args' => [ [ 'replicaOnly' => false ] ]
2412 'loggroup' => 'SQLBagOStuff',
2413 'reportDupes' => false
2416 'apc' => [ 'class' => APCBagOStuff
::class, 'reportDupes' => false ],
2417 'apcu' => [ 'class' => APCUBagOStuff
::class, 'reportDupes' => false ],
2418 'wincache' => [ 'class' => WinCacheBagOStuff
::class, 'reportDupes' => false ],
2419 'memcached-php' => [ 'class' => MemcachedPhpBagOStuff
::class, 'loggroup' => 'memcached' ],
2420 'memcached-pecl' => [ 'class' => MemcachedPeclBagOStuff
::class, 'loggroup' => 'memcached' ],
2421 'hash' => [ 'class' => HashBagOStuff
::class, 'reportDupes' => false ],
2425 * Main Wide-Area-Network cache type. This should be a cache with fast access,
2426 * but it may have limited space. By default, it is disabled, since the basic stock
2427 * cache is not fast enough to make it worthwhile. For single data-center setups, this can
2428 * simply be pointed to a cache in $wgWANObjectCaches that uses a local $wgObjectCaches
2429 * cache with a relayer of type EventRelayerNull.
2432 * - false: Configure the cache using $wgMainCacheType, without using
2433 * a relayer (only matters if there are multiple data-centers)
2434 * - CACHE_NONE: Do not cache
2435 * - (other): A string may be used which identifies a cache
2436 * configuration in $wgWANObjectCaches
2439 $wgMainWANCache = false;
2442 * Advanced WAN object cache configuration.
2444 * Each WAN cache wraps a registered object cache (for the local cluster)
2445 * and it must also be configured to point to a PubSub instance. Subscribers
2446 * must be configured to relay purges to the actual cache servers.
2448 * The format is an associative array where the key is a cache identifier, and
2449 * the value is an associative array of parameters. The "cacheId" parameter is
2450 * a cache identifier from $wgObjectCaches. The "loggroup" parameter controls
2451 * where log events are sent.
2455 $wgWANObjectCaches = [
2457 'class' => WANObjectCache
::class,
2458 'cacheId' => CACHE_NONE
2460 /* Example of a simple single data-center cache:
2461 'memcached-php' => [
2462 'class' => WANObjectCache::class,
2463 'cacheId' => 'memcached-php'
2469 * Verify and enforce WAN cache purges using reliable DB sources as streams.
2471 * These secondary cache purges are de-duplicated via simple cache mutexes.
2472 * This improves consistency when cache purges are lost, which becomes more likely
2473 * as more cache servers are added or if there are multiple datacenters. Only keys
2474 * related to important mutable content will be checked.
2479 $wgEnableWANCacheReaper = false;
2482 * The object store type of the main stash.
2484 * This store should be a very fast storage system optimized for holding lightweight data
2485 * like incrementable hit counters and current user activity. The store should replicate the
2486 * dataset among all data-centers. Any add(), merge(), lock(), and unlock() operations should
2487 * maintain "best effort" linearizability; as long as connectivity is strong, latency is low,
2488 * and there is no eviction pressure prompted by low free space, those operations should be
2489 * linearizable. In terms of PACELC (https://en.wikipedia.org/wiki/PACELC_theorem), the store
2490 * should act as a PA/EL distributed system for these operations. One optimization for these
2491 * operations is to route them to a "primary" data-center (e.g. one that serves HTTP POST) for
2492 * synchronous execution and then replicate to the others asynchronously. This means that at
2493 * least calls to these operations during HTTP POST requests would quickly return.
2495 * All other operations, such as get(), set(), delete(), changeTTL(), incr(), and decr(),
2496 * should be synchronous in the local data-center, replicating asynchronously to the others.
2497 * This behavior can be overriden by the use of the WRITE_SYNC and READ_LATEST flags.
2499 * The store should *preferably* have eventual consistency to handle network partitions.
2501 * Modules that rely on the stash should be prepared for:
2502 * - add(), merge(), lock(), and unlock() to be slower than other write operations,
2503 * at least in "secondary" data-centers (e.g. one that only serves HTTP GET/HEAD)
2504 * - Other write operations to have race conditions accross data-centers
2505 * - Read operations to have race conditions accross data-centers
2506 * - Consistency to be either eventual (with Last-Write-Wins) or just "best effort"
2508 * In general, this means avoiding updates during idempotent HTTP requests (GET/HEAD) and
2509 * avoiding assumptions of true linearizability (e.g. accepting anomalies). Modules that need
2510 * these kind of guarantees should use other storage mediums.
2513 * - db: Store cache objects in the DB
2514 * - (other): A string may be used which identifies a cache
2515 * configuration in $wgObjectCaches
2519 $wgMainStash = 'db-replicated';
2522 * The expiry time for the parser cache, in seconds.
2523 * The default is 86400 (one day).
2525 $wgParserCacheExpireTime = 86400;
2528 * The expiry time to use for session storage, in seconds.
2530 $wgObjectCacheSessionExpiry = 3600;
2533 * Whether to use PHP session handling ($_SESSION and session_*() functions)
2535 * If the constant MW_NO_SESSION is defined, this is forced to 'disable'.
2537 * If the constant MW_NO_SESSION_HANDLER is defined, this is ignored and PHP
2538 * session handling will function independently of SessionHandler.
2539 * SessionHandler and PHP's session handling may attempt to override each
2544 * - 'enable': Integrate with PHP's session handling as much as possible.
2545 * - 'warn': Integrate but log warnings if anything changes $_SESSION.
2546 * - 'disable': Throw exceptions if PHP session handling is used.
2548 $wgPHPSessionHandling = 'enable';
2551 * Number of internal PBKDF2 iterations to use when deriving session secrets.
2555 $wgSessionPbkdf2Iterations = 10001;
2558 * The list of MemCached servers and port numbers
2560 $wgMemCachedServers = [ '127.0.0.1:11211' ];
2563 * Use persistent connections to MemCached, which are shared across multiple
2566 $wgMemCachedPersistent = false;
2569 * Read/write timeout for MemCached server communication, in microseconds.
2571 $wgMemCachedTimeout = 500000;
2574 * Set this to true to maintain a copy of the message cache on the local server.
2576 * This layer of message cache is in addition to the one configured by $wgMessageCacheType.
2578 * The local copy is put in APC. If APC is not installed, this setting does nothing.
2580 * Note that this is about the message cache, which stores interface messages
2581 * maintained as wiki pages. This is separate from the localisation cache for interface
2582 * messages provided by the software, which is configured by $wgLocalisationCacheConf.
2584 $wgUseLocalMessageCache = false;
2587 * Instead of caching everything, only cache those messages which have
2588 * been customised in the site content language. This means that
2589 * MediaWiki:Foo/ja is ignored if MediaWiki:Foo doesn't exist.
2590 * This option is probably only useful for translatewiki.net.
2592 $wgAdaptiveMessageCache = false;
2595 * Localisation cache configuration.
2597 * Used by Language::getLocalisationCache() to decide how to construct the
2598 * LocalisationCache instance. Associative array with keys:
2600 * class: The class to use for constructing the LocalisationCache object.
2601 * This may be overridden by extensions to a subclass of LocalisationCache.
2602 * Sub classes are expected to still honor the 'storeClass', 'storeDirectory'
2603 * and 'manualRecache' options where applicable.
2605 * storeClass: Which LCStore class implementation to use. This is optional.
2606 * The default LocalisationCache class offers the 'store' option
2607 * as abstraction for this.
2609 * store: How and where to store localisation cache data.
2610 * This option is ignored if 'storeClass' is explicitly set to a class name.
2612 * - 'detect' (default): Automatically select 'files' if 'storeDirectory'
2613 * or $wgCacheDirectory is set, and fall back to 'db' otherwise.
2614 * - 'files': Store in $wgCacheDirectory as CDB files.
2615 * - 'array': Store in $wgCacheDirectory as PHP static array files.
2616 * - 'db': Store in the l10n_cache database table.
2618 * storeDirectory: If the selected LCStore class puts its data in files, then it
2619 * will use this directory. If set to false (default), then
2620 * $wgCacheDirectory is used instead.
2622 * manualRecache: Set this to true to disable cache updates on web requests.
2623 * Use maintenance/rebuildLocalisationCache.php instead.
2625 $wgLocalisationCacheConf = [
2626 'class' => LocalisationCache
::class,
2627 'store' => 'detect',
2628 'storeClass' => false,
2629 'storeDirectory' => false,
2630 'manualRecache' => false,
2634 * Allow client-side caching of pages
2636 $wgCachePages = true;
2639 * Set this to current time to invalidate all prior cached pages. Affects both
2640 * client-side and server-side caching.
2641 * You can get the current date on your server by using the command:
2643 * date +%Y%m%d%H%M%S
2646 $wgCacheEpoch = '20030516000000';
2649 * Directory where GitInfo will look for pre-computed cache files. If false,
2650 * $wgCacheDirectory/gitinfo will be used.
2652 $wgGitInfoCacheDirectory = false;
2655 * This will cache static pages for non-logged-in users to reduce
2656 * database traffic on public sites. ResourceLoader requests to default
2657 * language and skins are cached as well as single module requests.
2659 $wgUseFileCache = false;
2662 * Depth of the subdirectory hierarchy to be created under
2663 * $wgFileCacheDirectory. The subdirectories will be named based on
2664 * the MD5 hash of the title. A value of 0 means all cache files will
2665 * be put directly into the main file cache directory.
2667 $wgFileCacheDepth = 2;
2670 * Append a configured value to the parser cache and the sitenotice key so
2671 * that they can be kept separate for some class of activity.
2673 $wgRenderHashAppend = '';
2676 * If on, the sidebar navigation links are cached for users with the
2677 * current language set. This can save a touch of load on a busy site
2678 * by shaving off extra message lookups.
2680 * However it is also fragile: changing the site configuration, or
2681 * having a variable $wgArticlePath, can produce broken links that
2682 * don't update as expected.
2684 $wgEnableSidebarCache = false;
2687 * Expiry time for the sidebar cache, in seconds
2689 $wgSidebarCacheExpiry = 86400;
2692 * When using the file cache, we can store the cached HTML gzipped to save disk
2693 * space. Pages will then also be served compressed to clients that support it.
2695 * Requires zlib support enabled in PHP.
2700 * Invalidate various caches when LocalSettings.php changes. This is equivalent
2701 * to setting $wgCacheEpoch to the modification time of LocalSettings.php, as
2702 * was previously done in the default LocalSettings.php file.
2704 * On high-traffic wikis, this should be set to false, to avoid the need to
2705 * check the file modification time, and to avoid the performance impact of
2706 * unnecessary cache invalidations.
2708 $wgInvalidateCacheOnLocalSettingsChange = true;
2711 * When loading extensions through the extension registration system, this
2712 * can be used to invalidate the cache. A good idea would be to set this to
2713 * one file, you can just `touch` that one to invalidate the cache
2717 * $wgExtensionInfoMtime = filemtime( "$IP/LocalSettings.php" );
2720 * If set to false, the mtime for each individual JSON file will be checked,
2721 * which can be slow if a large number of extensions are being loaded.
2725 $wgExtensionInfoMTime = false;
2727 /** @} */ # end of cache settings
2729 /************************************************************************//**
2730 * @name HTTP proxy (CDN) settings
2732 * Many of these settings apply to any HTTP proxy used in front of MediaWiki,
2733 * although they are sometimes still referred to as Squid settings for
2734 * historical reasons.
2736 * Achieving a high hit ratio with an HTTP proxy requires special
2737 * configuration. See https://www.mediawiki.org/wiki/Manual:Squid_caching for
2744 * Enable/disable CDN.
2745 * See https://www.mediawiki.org/wiki/Manual:Squid_caching
2747 * @since 1.34 Renamed from $wgUseSquid.
2752 * If you run Squid3 with ESI support, enable this (default:false):
2753 * @deprecated in 1.33. This was a now-defunct experimental feature.
2758 * Add X-Forwarded-Proto to the Vary and Key headers for API requests and
2759 * RSS/Atom feeds. Use this if you have an SSL termination setup
2760 * and need to split the cache between HTTP and HTTPS for API requests,
2761 * feed requests and HTTP redirect responses in order to prevent cache
2762 * pollution. This does not affect 'normal' requests to index.php other than
2765 $wgVaryOnXFP = false;
2768 * Internal server name as known to CDN, if different.
2772 * $wgInternalServer = 'http://yourinternal.tld:8000';
2775 $wgInternalServer = false;
2778 * Cache TTL for the CDN sent as s-maxage (without ESI) or
2779 * Surrogate-Control (with ESI). Without ESI, you should strip
2780 * out s-maxage in the CDN config.
2782 * 18000 seconds = 5 hours, more cache hits with 2678400 = 31 days.
2784 * @since 1.34 Renamed from $wgSquidMaxage
2786 $wgCdnMaxAge = 18000;
2789 * Cache timeout for the CDN when DB replica DB lag is high
2794 $wgCdnMaxageLagged = 30;
2797 * If set, any SquidPurge call on a URL or URLs will send a second purge no less than
2798 * this many seconds later via the job queue. This requires delayed job support.
2799 * This should be safely higher than the 'max lag' value in $wgLBFactoryConf, so that
2800 * replica DB lag does not cause page to be stuck in stales states in CDN.
2802 * This also fixes race conditions in two-tiered CDN setups (e.g. cdn2 => cdn1 => MediaWiki).
2803 * If a purge for a URL reaches cdn2 before cdn1 and a request reaches cdn2 for that URL,
2804 * it will populate the response from the stale cdn1 value. When cdn1 gets the purge, cdn2
2805 * will still be stale. If the rebound purge delay is safely higher than the time to relay
2806 * a purge to all nodes, then the rebound purge will clear cdn2 after cdn1 was cleared.
2810 $wgCdnReboundPurgeDelay = 0;
2813 * Cache timeout for the CDN when a response is known to be wrong or incomplete (due to load)
2817 $wgCdnMaxageSubstitute = 60;
2820 * Default maximum age for raw CSS/JS accesses
2822 * 300 seconds = 5 minutes.
2824 $wgForcedRawSMaxage = 300;
2827 * List of proxy servers to purge on changes; default port is 80. Use IP addresses.
2829 * When MediaWiki is running behind a proxy, it will trust X-Forwarded-For
2830 * headers sent/modified from these proxies when obtaining the remote IP address
2832 * For a list of trusted servers which *aren't* purged, see $wgSquidServersNoPurge.
2834 * @since 1.34 Renamed from $wgSquidServers.
2839 * As with $wgCdnServers, except these servers aren't purged on page changes;
2840 * use to set a list of trusted proxies, etc. Supports both individual IP
2841 * addresses and CIDR blocks.
2843 * @since 1.23 Supports CIDR ranges
2844 * @since 1.34 Renamed from $wgSquidServersNoPurge
2846 $wgCdnServersNoPurge = [];
2849 * Whether to use a Host header in purge requests sent to the proxy servers
2850 * configured in $wgCdnServers. Set this to false to support a CDN
2851 * configured in forward-proxy mode.
2853 * If this is set to true, a Host header will be sent, and only the path
2854 * component of the URL will appear on the request line, as if the request
2855 * were a non-proxy HTTP 1.1 request. Varnish only supports this style of
2856 * request. Squid supports this style of request only if reverse-proxy mode
2857 * (http_port ... accel) is enabled.
2859 * If this is set to false, no Host header will be sent, and the absolute URL
2860 * will be sent in the request line, as is the standard for an HTTP proxy
2861 * request in both HTTP 1.0 and 1.1. This style of request is not supported
2862 * by Varnish, but is supported by Squid in either configuration (forward or
2866 * @deprecated since 1.33, will always be true in a future release.
2868 $wgSquidPurgeUseHostHeader = true;
2871 * Routing configuration for HTCP multicast purging. Add elements here to
2872 * enable HTCP and determine which purges are sent where. If set to an empty
2873 * array, HTCP is disabled.
2875 * Each key in this array is a regular expression to match against the purged
2876 * URL, or an empty string to match all URLs. The purged URL is matched against
2877 * the regexes in the order specified, and the first rule whose regex matches
2878 * is used, all remaining rules will thus be ignored.
2880 * @par Example configuration to send purges for upload.wikimedia.org to one
2881 * multicast group and all other purges to another:
2883 * $wgHTCPRouting = [
2884 * '|^https?://upload\.wikimedia\.org|' => [
2885 * 'host' => '239.128.0.113',
2889 * 'host' => '239.128.0.112',
2895 * You can also pass an array of hosts to send purges too. This is useful when
2896 * you have several multicast groups or unicast address that should receive a
2897 * given purge. Multiple hosts support was introduced in MediaWiki 1.22.
2899 * @par Example of sending purges to multiple hosts:
2901 * $wgHTCPRouting = [
2903 * // Purges to text caches using multicast
2904 * [ 'host' => '239.128.0.114', 'port' => '4827' ],
2905 * // Purges to a hardcoded list of caches
2906 * [ 'host' => '10.88.66.1', 'port' => '4827' ],
2907 * [ 'host' => '10.88.66.2', 'port' => '4827' ],
2908 * [ 'host' => '10.88.66.3', 'port' => '4827' ],
2914 * @see $wgHTCPMulticastTTL
2916 $wgHTCPRouting = [];
2919 * HTCP multicast TTL.
2920 * @see $wgHTCPRouting
2922 $wgHTCPMulticastTTL = 1;
2925 * Should forwarded Private IPs be accepted?
2927 $wgUsePrivateIPs = false;
2929 /** @} */ # end of HTTP proxy settings
2931 /************************************************************************//**
2932 * @name Language, regional and character encoding settings
2937 * Site language code. See languages/data/Names.php for languages supported by
2938 * MediaWiki out of the box. Not all languages listed there have translations,
2939 * see languages/messages/ for the list of languages with some localisation.
2941 * Warning: Don't use any of MediaWiki's deprecated language codes listed in
2942 * LanguageCode::getDeprecatedCodeMapping or $wgDummyLanguageCodes, like "no"
2943 * for Norwegian (use "nb" instead). If you do, things will break unexpectedly.
2945 * This defines the default interface language for all users, but users can
2946 * change it in their preferences.
2948 * This also defines the language of pages in the wiki. The content is wrapped
2949 * in a html element with lang=XX attribute. This behavior can be overridden
2950 * via hooks, see Title::getPageLanguage.
2952 $wgLanguageCode = 'en';
2955 * Language cache size, or really how many languages can we handle
2956 * simultaneously without degrading to crawl speed.
2958 $wgLangObjCacheSize = 10;
2961 * Some languages need different word forms, usually for different cases.
2962 * Used in Language::convertGrammar().
2966 * $wgGrammarForms['en']['genitive']['car'] = 'car\'s';
2969 $wgGrammarForms = [];
2972 * Treat language links as magic connectors, not inline links
2974 $wgInterwikiMagic = true;
2977 * Hide interlanguage links from the sidebar
2979 $wgHideInterlanguageLinks = false;
2982 * List of additional interwiki prefixes that should be treated as
2983 * interlanguage links (i.e. placed in the sidebar).
2985 * - This will not do anything unless the prefixes are defined in the interwiki
2987 * - The display text for these custom interlanguage links will be fetched from
2988 * the system message "interlanguage-link-xyz" where xyz is the prefix in
2990 * - A friendly name for each site, used for tooltip text, may optionally be
2991 * placed in the system message "interlanguage-link-sitename-xyz" where xyz is
2992 * the prefix in this array.
2994 $wgExtraInterlanguageLinkPrefixes = [];
2997 * List of language names or overrides for default names in Names.php
2999 $wgExtraLanguageNames = [];
3002 * List of mappings from one language code to another.
3003 * This array makes the codes not appear as a selectable language on the
3004 * installer, and excludes them when running the transstat.php script.
3006 * In Setup.php, the variable $wgDummyLanguageCodes is created by combining
3007 * these codes with a list of "deprecated" codes, which are mostly leftovers
3008 * from renames or other legacy things, and the internal codes 'qqq' and 'qqx'.
3009 * If a mapping in $wgExtraLanguageCodes collide with a built-in mapping, the
3010 * value in $wgExtraLanguageCodes will be used.
3014 $wgExtraLanguageCodes = [
3015 // Language codes of macro languages, which get mapped to the main language
3016 'bh' => 'bho', // Bihari language family
3017 'no' => 'nb', // Norwegian language family
3019 // Language variants which get mapped to the main language
3020 'simple' => 'en', // Simple English
3024 * Functionally the same as $wgExtraLanguageCodes, but deprecated. Instead of
3025 * appending values to this array, append them to $wgExtraLanguageCodes.
3027 * @deprecated since 1.29
3029 $wgDummyLanguageCodes = [];
3032 * Set this to true to replace Arabic presentation forms with their standard
3033 * forms in the U+0600-U+06FF block. This only works if $wgLanguageCode is
3036 * Note that pages with titles containing presentation forms will become
3037 * inaccessible, run maintenance/cleanupTitles.php to fix this.
3039 * @deprecated since 1.33: in the future will always be true.
3041 $wgFixArabicUnicode = true;
3044 * Set this to true to replace ZWJ-based chillu sequences in Malayalam text
3045 * with their Unicode 5.1 equivalents. This only works if $wgLanguageCode is
3046 * set to "ml". Note that some clients (even new clients as of 2010) do not
3047 * support these characters.
3049 * If you enable this on an existing wiki, run maintenance/cleanupTitles.php to
3050 * fix any ZWJ sequences in existing page titles.
3052 * @deprecated since 1.33: in the future will always be true.
3054 $wgFixMalayalamUnicode = true;
3057 * Set this to always convert certain Unicode sequences to modern ones
3058 * regardless of the content language. This has a small performance
3061 * See $wgFixArabicUnicode and $wgFixMalayalamUnicode for conversion
3066 $wgAllUnicodeFixes = false;
3069 * Set this to eg 'ISO-8859-1' to perform character set conversion when
3070 * loading old revisions not marked with "utf-8" flag. Use this when
3071 * converting a wiki from MediaWiki 1.4 or earlier to UTF-8 without the
3072 * burdensome mass conversion of old text data.
3074 * @note This DOES NOT touch any fields other than old_text. Titles, comments,
3075 * user names, etc still must be converted en masse in the database before
3076 * continuing as a UTF-8 wiki.
3078 $wgLegacyEncoding = false;
3081 * If set to true, the MediaWiki 1.4 to 1.5 schema conversion will
3082 * create stub reference rows in the text table instead of copying
3083 * the full text of all current entries from 'cur' to 'text'.
3085 * This will speed up the conversion step for large sites, but
3086 * requires that the cur table be kept around for those revisions
3087 * to remain viewable.
3089 * This option affects the updaters *only*. Any present cur stub
3090 * revisions will be readable at runtime regardless of this setting.
3092 $wgLegacySchemaConversion = false;
3095 * Enable dates like 'May 12' instead of '12 May', if the default date format
3098 $wgAmericanDates = false;
3101 * For Hindi and Arabic use local numerals instead of Western style (0-9)
3102 * numerals in interface.
3104 $wgTranslateNumerals = true;
3107 * Translation using MediaWiki: namespace.
3108 * Interface messages will be loaded from the database.
3110 $wgUseDatabaseMessages = true;
3113 * Maximum entry size in the message cache, in bytes
3115 $wgMaxMsgCacheEntrySize = 10000;
3118 * Whether to enable language variant conversion.
3120 $wgDisableLangConversion = false;
3123 * Whether to enable language variant conversion for links.
3125 $wgDisableTitleConversion = false;
3128 * Default variant code, if false, the default will be the language code
3130 $wgDefaultLanguageVariant = false;
3133 * Whether to enable the pig Latin variant of English (en-x-piglatin),
3134 * used to ease variant development work.
3136 $wgUsePigLatinVariant = false;
3139 * Disabled variants array of language variant conversion.
3143 * $wgDisabledVariants[] = 'zh-mo';
3144 * $wgDisabledVariants[] = 'zh-my';
3147 $wgDisabledVariants = [];
3150 * Like $wgArticlePath, but on multi-variant wikis, this provides a
3151 * path format that describes which parts of the URL contain the
3156 * $wgLanguageCode = 'sr';
3157 * $wgVariantArticlePath = '/$2/$1';
3158 * $wgArticlePath = '/wiki/$1';
3161 * A link to /wiki/ would be redirected to /sr/Главна_страна
3163 * It is important that $wgArticlePath not overlap with possible values
3164 * of $wgVariantArticlePath.
3166 $wgVariantArticlePath = false;
3169 * Show a bar of language selection links in the user login and user
3170 * registration forms; edit the "loginlanguagelinks" message to
3173 $wgLoginLanguageSelector = false;
3176 * When translating messages with wfMessage(), it is not always clear what
3177 * should be considered UI messages and what should be content messages.
3179 * For example, for the English Wikipedia, there should be only one 'mainpage',
3180 * so when getting the link for 'mainpage', we should treat it as site content
3181 * and call ->inContentLanguage()->text(), but for rendering the text of the
3182 * link, we call ->text(). The code behaves this way by default. However,
3183 * sites like the Wikimedia Commons do offer different versions of 'mainpage'
3184 * and the like for different languages. This array provides a way to override
3185 * the default behavior.
3188 * To allow language-specific main page and community
3191 * $wgForceUIMsgAsContentMsg = [ 'mainpage', 'portal-url' ];
3194 $wgForceUIMsgAsContentMsg = [];
3197 * Fake out the timezone that the server thinks it's in. This will be used for
3198 * date display and not for what's stored in the DB. Leave to null to retain
3199 * your server's OS-based timezone value.
3201 * This variable is currently used only for signature formatting and for local
3202 * time/date parser variables ({{LOCALTIME}} etc.)
3204 * Timezones can be translated by editing MediaWiki messages of type
3205 * timezone-nameinlowercase like timezone-utc.
3207 * A list of usable timezones can found at:
3208 * https://www.php.net/manual/en/timezones.php
3212 * $wgLocaltimezone = 'UTC';
3213 * $wgLocaltimezone = 'GMT';
3214 * $wgLocaltimezone = 'PST8PDT';
3215 * $wgLocaltimezone = 'Europe/Sweden';
3216 * $wgLocaltimezone = 'CET';
3219 $wgLocaltimezone = null;
3222 * Set an offset from UTC in minutes to use for the default timezone setting
3223 * for anonymous users and new user accounts.
3225 * This setting is used for most date/time displays in the software, and is
3226 * overridable in user preferences. It is *not* used for signature timestamps.
3228 * By default, this will be set to match $wgLocaltimezone.
3230 $wgLocalTZoffset = null;
3233 * List of Unicode characters for which capitalization is overridden in
3234 * Language::ucfirst. The characters should be
3235 * represented as char_to_convert => conversion_override. See T219279 for details
3236 * on why this is useful during php version transitions.
3238 * @warning: EXPERIMENTAL!
3243 $wgOverrideUcfirstCharacters = [];
3245 /** @} */ # End of language/charset settings
3247 /*************************************************************************//**
3248 * @name Output format and skin settings
3253 * The default Content-Type header.
3255 $wgMimeType = 'text/html';
3258 * Defines the value of the version attribute in the <html> tag, if any.
3260 * If your wiki uses RDFa, set it to the correct value for RDFa+HTML5.
3261 * Correct current values are 'HTML+RDFa 1.0' or 'XHTML+RDFa 1.0'.
3262 * See also https://www.w3.org/TR/rdfa-in-html/#document-conformance
3265 $wgHtml5Version = null;
3268 * Temporary variable that allows HTMLForms to be rendered as tables.
3269 * Table based layouts cause various issues when designing for mobile.
3270 * This global allows skins or extensions a means to force non-table based rendering.
3271 * Setting to false forces form components to always render as div elements.
3274 $wgHTMLFormAllowTableFormat = true;
3277 * Temporary variable that applies MediaWiki UI wherever it can be supported.
3278 * Temporary variable that should be removed when mediawiki ui is more
3279 * stable and change has been communicated.
3282 $wgUseMediaWikiUIEverywhere = false;
3285 * Whether to label the store-to-database-and-show-to-others button in the editor
3286 * as "Save page"/"Save changes" if false (the default) or, if true, instead as
3287 * "Publish page"/"Publish changes".
3291 $wgEditSubmitButtonLabelPublish = false;
3294 * Permit other namespaces in addition to the w3.org default.
3296 * Use the prefix for the key and the namespace for the value.
3300 * $wgXhtmlNamespaces['svg'] = 'http://www.w3.org/2000/svg';
3302 * Normally we wouldn't have to define this in the root "<html>"
3303 * element, but IE needs it there in some circumstances.
3305 * This is ignored if $wgMimeType is set to a non-XML MIME type.
3307 $wgXhtmlNamespaces = [];
3310 * Site notice shown at the top of each page
3312 * MediaWiki:Sitenotice page, which will override this. You can also
3313 * provide a separate message for logged-out users using the
3314 * MediaWiki:Anonnotice page.
3319 * Default skin, for new users and anonymous visitors. Registered users may
3320 * change this to any one of the other available skins in their preferences.
3322 $wgDefaultSkin = 'vector';
3325 * Fallback skin used when the skin defined by $wgDefaultSkin can't be found.
3329 $wgFallbackSkin = 'fallback';
3332 * Specify the names of skins that should not be presented in the list of
3333 * available skins in user preferences. If you want to remove a skin entirely,
3334 * remove it from the skins/ directory and its entry from LocalSettings.php.
3339 * @deprecated since 1.23; use $wgSkipSkins instead
3344 * Allow user Javascript page?
3345 * This enables a lot of neat customizations, but may
3346 * increase security risk to users and server load.
3348 $wgAllowUserJs = false;
3351 * Allow user Cascading Style Sheets (CSS)?
3352 * This enables a lot of neat customizations, but may
3353 * increase security risk to users and server load.
3355 $wgAllowUserCss = false;
3358 * Allow style-related user-preferences?
3360 * This controls whether the `editfont` and `underline` preferences
3361 * are available to users.
3363 $wgAllowUserCssPrefs = true;
3366 * Use the site's Javascript page?
3368 $wgUseSiteJs = true;
3371 * Use the site's Cascading Style Sheets (CSS)?
3373 $wgUseSiteCss = true;
3376 * Break out of framesets. This can be used to prevent clickjacking attacks,
3377 * or to prevent external sites from framing your site with ads.
3379 $wgBreakFrames = false;
3382 * The X-Frame-Options header to send on pages sensitive to clickjacking
3383 * attacks, such as edit pages. This prevents those pages from being displayed
3384 * in a frame or iframe. The options are:
3386 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3388 * - 'SAMEORIGIN': Allow framing by pages on the same domain. This can be used
3389 * to allow framing within a trusted domain. This is insecure if there
3390 * is a page on the same domain which allows framing of arbitrary URLs.
3392 * - false: Allow all framing. This opens up the wiki to XSS attacks and thus
3393 * full compromise of local user accounts. Private wikis behind a
3394 * corporate firewall are especially vulnerable. This is not
3397 * For extra safety, set $wgBreakFrames = true, to prevent framing on all pages,
3398 * not just edit pages.
3400 $wgEditPageFrameOptions = 'DENY';
3403 * Disallow framing of API pages directly, by setting the X-Frame-Options
3404 * header. Since the API returns CSRF tokens, allowing the results to be
3405 * framed can compromise your user's account security.
3407 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3408 * - 'SAMEORIGIN': Allow framing by pages on the same domain.
3409 * - false: Allow all framing.
3410 * Note: $wgBreakFrames will override this for human formatted API output.
3412 $wgApiFrameOptions = 'DENY';
3415 * Disable output compression (enabled by default if zlib is available)
3417 $wgDisableOutputCompression = false;
3420 * How should section IDs be encoded?
3421 * This array can contain 1 or 2 elements, each of them can be one of:
3422 * - 'html5' is modern HTML5 style encoding with minimal escaping. Displays Unicode
3423 * characters in most browsers' address bars.
3424 * - 'legacy' is old MediaWiki-style encoding, e.g. 啤酒 turns into .E5.95.A4.E9.85.92
3426 * The first element of this array specifies the primary mode of escaping IDs. This
3427 * is what users will see when they e.g. follow an [[#internal link]] to a section of
3430 * The optional second element defines a fallback mode, useful for migrations.
3431 * If present, it will direct MediaWiki to add empty <span>s to every section with its
3432 * id attribute set to fallback encoded title so that links using the previous encoding
3435 * Example: you want to migrate your wiki from 'legacy' to 'html5'
3437 * On the first step, set this variable to [ 'legacy', 'html5' ]. After a while, when
3438 * all caches (parser, HTTP, etc.) contain only pages generated with this setting,
3439 * flip the value to [ 'html5', 'legacy' ]. This will result in all internal links being
3440 * generated in the new encoding while old links (both external and cached internal) will
3441 * still work. After a long time, you might want to ditch backwards compatibility and
3442 * set it to [ 'html5' ]. After all, pages get edited, breaking incoming links no matter which
3443 * fragment mode is used.
3447 $wgFragmentMode = [ 'legacy', 'html5' ];
3450 * Which ID escaping mode should be used for external interwiki links? See documentation
3451 * for $wgFragmentMode above for details of each mode. Because you can't control external sites,
3452 * this setting should probably always be 'legacy', unless every wiki you link to has converted
3457 $wgExternalInterwikiFragmentMode = 'legacy';
3460 * Abstract list of footer icons for skins in place of old copyrightico and poweredbyico code
3461 * You can add new icons to the built in copyright or poweredby, or you can create
3462 * a new block. Though note that you may need to add some custom css to get good styling
3463 * of new blocks in monobook. vector and modern should work without any special css.
3465 * $wgFooterIcons itself is a key/value array.
3466 * The key is the name of a block that the icons will be wrapped in. The final id varies
3467 * by skin; Monobook and Vector will turn poweredby into f-poweredbyico while Modern
3468 * turns it into mw_poweredby.
3469 * The value is either key/value array of icons or a string.
3470 * In the key/value array the key may or may not be used by the skin but it can
3471 * be used to find the icon and unset it or change the icon if needed.
3472 * This is useful for disabling icons that are set by extensions.
3473 * The value should be either a string or an array. If it is a string it will be output
3474 * directly as html, however some skins may choose to ignore it. An array is the preferred format
3475 * for the icon, the following keys are used:
3476 * - src: An absolute url to the image to use for the icon, this is recommended
3477 * but not required, however some skins will ignore icons without an image
3478 * - srcset: optional additional-resolution images; see HTML5 specs
3479 * - url: The url to use in the a element around the text or icon, if not set an a element will
3481 * - alt: This is the text form of the icon, it will be displayed without an image in
3482 * skins like Modern or if src is not set, and will otherwise be used as
3483 * the alt="" for the image. This key is required.
3484 * - width and height: If the icon specified by src is not of the standard size
3485 * you can specify the size of image to use with these keys.
3486 * Otherwise they will default to the standard 88x31.
3487 * @todo Reformat documentation.
3491 "copyright" => [], // placeholder for the built in copyright icon
3495 // Defaults to point at
3496 // "$wgResourceBasePath/resources/assets/poweredby_mediawiki_88x31.png"
3497 // plus srcset for 1.5x, 2x resolution variants.
3499 "url" => "https://www.mediawiki.org/",
3500 "alt" => "Powered by MediaWiki",
3506 * Login / create account link behavior when it's possible for anonymous users
3507 * to create an account.
3508 * - true = use a combined login / create account link
3509 * - false = split login and create account into two separate links
3511 $wgUseCombinedLoginLink = false;
3514 * Display user edit counts in various prominent places.
3516 $wgEdititis = false;
3519 * Some web hosts attempt to rewrite all responses with a 404 (not found)
3520 * status code, mangling or hiding MediaWiki's output. If you are using such a
3521 * host, you should start looking for a better one. While you're doing that,
3522 * set this to false to convert some of MediaWiki's 404 responses to 200 so
3523 * that the generated error pages can be seen.
3525 * In cases where for technical reasons it is more important for MediaWiki to
3526 * send the correct status code than for the body to be transmitted intact,
3527 * this configuration variable is ignored.
3529 $wgSend404Code = true;
3532 * The $wgShowRollbackEditCount variable is used to show how many edits can be rolled back.
3533 * The numeric value of the variable controls how many edits MediaWiki will look back to
3534 * determine whether a rollback is allowed (by checking that they are all from the same author).
3535 * If the value is false or 0, the edits are not counted. Disabling this will prevent MediaWiki
3536 * from hiding some useless rollback links.
3540 $wgShowRollbackEditCount = 10;
3543 * Output a <link rel="canonical"> tag on every page indicating the canonical
3544 * server which should be used, i.e. $wgServer or $wgCanonicalServer. Since
3545 * detection of the current server is unreliable, the link is sent
3548 $wgEnableCanonicalServerLink = false;
3551 * When OutputHandler is used, mangle any output that contains
3552 * <cross-domain-policy>. Without this, an attacker can send their own
3553 * cross-domain policy unless it is prevented by the crossdomain.xml file at
3558 $wgMangleFlashPolicy = true;
3560 /** @} */ # End of output format settings }
3562 /*************************************************************************//**
3563 * @name ResourceLoader settings
3568 * Client-side resource modules.
3570 * Extensions should add their ResourceLoader module definitions
3571 * to the $wgResourceModules variable.
3575 * $wgResourceModules['ext.myExtension'] = [
3576 * 'scripts' => 'myExtension.js',
3577 * 'styles' => 'myExtension.css',
3578 * 'dependencies' => [ 'jquery.cookie', 'jquery.tabIndex' ],
3579 * 'localBasePath' => __DIR__,
3580 * 'remoteExtPath' => 'MyExtension',
3584 $wgResourceModules = [];
3587 * Skin-specific styles for resource modules.
3589 * These are later added to the 'skinStyles' list of the existing module. The 'styles' list can
3590 * not be modified or disabled.
3592 * For example, here is a module "bar" and how skin Foo would provide additional styles for it.
3596 * $wgResourceModules['bar'] = [
3597 * 'scripts' => 'resources/bar/bar.js',
3598 * 'styles' => 'resources/bar/main.css',
3601 * $wgResourceModuleSkinStyles['foo'] = [
3602 * 'bar' => 'skins/Foo/bar.css',
3606 * This is mostly equivalent to:
3610 * $wgResourceModules['bar'] = [
3611 * 'scripts' => 'resources/bar/bar.js',
3612 * 'styles' => 'resources/bar/main.css',
3614 * 'foo' => skins/Foo/bar.css',
3619 * If the module already defines its own entry in `skinStyles` for a given skin, then
3620 * $wgResourceModuleSkinStyles is ignored.
3622 * If a module defines a `skinStyles['default']` the skin may want to extend that instead
3623 * of replacing them. This can be done using the `+` prefix.
3627 * $wgResourceModules['bar'] = [
3628 * 'scripts' => 'resources/bar/bar.js',
3629 * 'styles' => 'resources/bar/basic.css',
3631 * 'default' => 'resources/bar/additional.css',
3634 * // Note the '+' character:
3635 * $wgResourceModuleSkinStyles['foo'] = [
3636 * '+bar' => 'skins/Foo/bar.css',
3640 * This is mostly equivalent to:
3644 * $wgResourceModules['bar'] = [
3645 * 'scripts' => 'resources/bar/bar.js',
3646 * 'styles' => 'resources/bar/basic.css',
3648 * 'default' => 'resources/bar/additional.css',
3650 * 'resources/bar/additional.css',
3651 * 'skins/Foo/bar.css',
3657 * In other words, as a module author, use the `styles` list for stylesheets that may not be
3658 * disabled by a skin. To provide default styles that may be extended or replaced,
3659 * use `skinStyles['default']`.
3661 * As with $wgResourceModules, paths default to being relative to the MediaWiki root.
3662 * You should always provide a localBasePath and remoteBasePath (or remoteExtPath/remoteSkinPath).
3666 * $wgResourceModuleSkinStyles['foo'] = [
3667 * 'bar' => 'bar.css',
3668 * 'quux' => 'quux.css',
3669 * 'remoteSkinPath' => 'Foo',
3670 * 'localBasePath' => __DIR__,
3674 $wgResourceModuleSkinStyles = [];
3677 * Extensions should register foreign module sources here. 'local' is a
3678 * built-in source that is not in this array, but defined by
3679 * ResourceLoader::__construct() so that it cannot be unset.
3683 * $wgResourceLoaderSources['foo'] = 'http://example.org/w/load.php';
3686 $wgResourceLoaderSources = [];
3689 * The default 'remoteBasePath' value for instances of ResourceLoaderFileModule.
3690 * Defaults to $wgScriptPath.
3692 $wgResourceBasePath = null;
3695 * Maximum time in seconds to cache resources served by ResourceLoader.
3696 * Used to set last modified headers (max-age/s-maxage).
3698 * Following options to distinguish:
3699 * - versioned: Used for modules with a version, because changing version
3700 * numbers causes cache misses. This normally has a long expiry time.
3701 * - unversioned: Used for modules without a version to propagate changes
3702 * quickly to clients. Also used for modules with errors to recover quickly.
3703 * This normally has a short expiry time.
3705 * Expiry time for the options to distinguish:
3706 * - server: Squid/Varnish but also any other public proxy cache between the
3707 * client and MediaWiki.
3708 * - client: On the client side (e.g. in the browser cache).
3710 $wgResourceLoaderMaxage = [
3712 'server' => 30 * 24 * 60 * 60, // 30 days
3713 'client' => 30 * 24 * 60 * 60, // 30 days
3716 'server' => 5 * 60, // 5 minutes
3717 'client' => 5 * 60, // 5 minutes
3722 * The default debug mode (on/off) for of ResourceLoader requests.
3724 * This will still be overridden when the debug URL parameter is used.
3726 $wgResourceLoaderDebug = false;
3729 * Whether to ensure the mediawiki.legacy library is loaded before other modules.
3731 * @deprecated since 1.26: Always declare dependencies.
3733 $wgIncludeLegacyJavaScript = false;
3736 * Whether or not to assign configuration variables to the global window object.
3738 * If this is set to false, old code using deprecated variables will no longer
3741 * @par Example of legacy code:
3743 * if ( window.wgRestrictionEdit ) { ... }
3747 * if ( wgIsArticle ) { ... }
3750 * Instead, one needs to use mw.config.
3751 * @par Example using mw.config global configuration:
3753 * if ( mw.config.exists('wgRestrictionEdit') ) { ... }
3757 * if ( mw.config.get('wgIsArticle') ) { ... }
3760 $wgLegacyJavaScriptGlobals = true;
3763 * If set to a positive number, ResourceLoader will not generate URLs whose
3764 * query string is more than this many characters long, and will instead use
3765 * multiple requests with shorter query strings. This degrades performance,
3766 * but may be needed if your web server has a low (less than, say 1024)
3767 * query string length limit or a low value for suhosin.get.max_value_length
3768 * that you can't increase.
3770 * If set to a negative number, ResourceLoader will assume there is no query
3771 * string length limit.
3773 * Defaults to a value based on php configuration.
3775 $wgResourceLoaderMaxQueryLength = false;
3778 * If set to true, JavaScript modules loaded from wiki pages will be parsed
3779 * prior to minification to validate it.
3781 * Parse errors will result in a JS exception being thrown during module load,
3782 * which avoids breaking other modules loaded in the same request.
3784 $wgResourceLoaderValidateJS = true;
3787 * When enabled, execution of JavaScript modules is profiled client-side.
3789 * Instrumentation happens in mw.loader.profiler.
3790 * Use `mw.inspect('time')` from the browser console to display the data.
3794 $wgResourceLoaderEnableJSProfiler = false;
3797 * Whether ResourceLoader should attempt to persist modules in localStorage on
3798 * browsers that support the Web Storage API.
3800 $wgResourceLoaderStorageEnabled = true;
3803 * Cache version for client-side ResourceLoader module storage. You can trigger
3804 * invalidation of the contents of the module store by incrementing this value.
3808 $wgResourceLoaderStorageVersion = 1;
3811 * Whether to allow site-wide CSS (MediaWiki:Common.css and friends) on
3812 * restricted pages like Special:UserLogin or Special:Preferences where
3813 * JavaScript is disabled for security reasons. As it is possible to
3814 * execute JavaScript through CSS, setting this to true opens up a
3815 * potential security hole. Some sites may "skin" their wiki by using
3816 * site-wide CSS, causing restricted pages to look unstyled and different
3817 * from the rest of the site.
3821 $wgAllowSiteCSSOnRestrictedPages = false;
3823 /** @} */ # End of ResourceLoader settings }
3825 /*************************************************************************//**
3826 * @name Page title and interwiki link settings
3831 * Name of the project namespace. If left set to false, $wgSitename will be
3834 $wgMetaNamespace = false;
3837 * Name of the project talk namespace.
3839 * Normally you can ignore this and it will be something like
3840 * $wgMetaNamespace . "_talk". In some languages, you may want to set this
3841 * manually for grammatical reasons.
3843 $wgMetaNamespaceTalk = false;
3846 * Additional namespaces. If the namespaces defined in Language.php and
3847 * Namespace.php are insufficient, you can create new ones here, for example,
3848 * to import Help files in other languages. You can also override the namespace
3849 * names of existing namespaces. Extensions should use the CanonicalNamespaces
3850 * hook or extension.json.
3852 * @warning Once you delete a namespace, the pages in that namespace will
3853 * no longer be accessible. If you rename it, then you can access them through
3854 * the new namespace name.
3856 * Custom namespaces should start at 100 to avoid conflicting with standard
3857 * namespaces, and should always follow the even/odd main/talk pattern.
3861 * $wgExtraNamespaces = [
3863 * 101 => "Hilfe_Diskussion",
3865 * 103 => "Discussion_Aide"
3869 * @todo Add a note about maintenance/namespaceDupes.php
3871 $wgExtraNamespaces = [];
3874 * Same as above, but for namespaces with gender distinction.
3875 * Note: the default form for the namespace should also be set
3876 * using $wgExtraNamespaces for the same index.
3879 $wgExtraGenderNamespaces = [];
3882 * Namespace aliases.
3884 * These are alternate names for the primary localised namespace names, which
3885 * are defined by $wgExtraNamespaces and the language file. If a page is
3886 * requested with such a prefix, the request will be redirected to the primary
3889 * Set this to a map from namespace names to IDs.
3893 * $wgNamespaceAliases = [
3894 * 'Wikipedian' => NS_USER,
3899 $wgNamespaceAliases = [];
3902 * Allowed title characters -- regex character class
3903 * Don't change this unless you know what you're doing
3905 * Problematic punctuation:
3906 * - []{}|# Are needed for link syntax, never enable these
3907 * - <> Causes problems with HTML escaping, don't use
3908 * - % Enabled by default, minor problems with path to query rewrite rules, see below
3909 * - + Enabled by default, but doesn't work with path to query rewrite rules,
3910 * corrupted by apache
3911 * - ? Enabled by default, but doesn't work with path to PATH_INFO rewrites
3913 * All three of these punctuation problems can be avoided by using an alias,
3914 * instead of a rewrite rule of either variety.
3916 * The problem with % is that when using a path to query rewrite rule, URLs are
3917 * double-unescaped: once by Apache's path conversion code, and again by PHP. So
3918 * %253F, for example, becomes "?". Our code does not double-escape to compensate
3919 * for this, indeed double escaping would break if the double-escaped title was
3920 * passed in the query string rather than the path. This is a minor security issue
3921 * because articles can be created such that they are hard to view or edit.
3923 * In some rare cases you may wish to remove + for compatibility with old links.
3925 $wgLegalTitleChars = " %!\"$&'()*,\\-.\\/0-9:;=?@A-Z\\\\^_`a-z~\\x80-\\xFF+";
3928 * The interwiki prefix of the current wiki, or false if it doesn't have one.
3930 * @deprecated since 1.23; use $wgLocalInterwikis instead
3932 $wgLocalInterwiki = false;
3935 * Array for multiple $wgLocalInterwiki values, in case there are several
3936 * interwiki prefixes that point to the current wiki. If $wgLocalInterwiki is
3937 * set, its value is prepended to this array, for backwards compatibility.
3939 * Note, recent changes feeds use only the first entry in this array (or
3940 * $wgLocalInterwiki, if it is set). See $wgRCFeeds
3942 $wgLocalInterwikis = [];
3945 * Expiry time for cache of interwiki table
3947 $wgInterwikiExpiry = 10800;
3950 * @name Interwiki caching settings.
3955 * Interwiki cache, either as an associative array or a path to a constant
3956 * database (.cdb) file.
3958 * This data structure database is generated by the `dumpInterwiki` maintenance
3959 * script (which lives in the WikimediaMaintenance repository) and has key
3960 * formats such as the following:
3962 * - dbname:key - a simple key (e.g. enwiki:meta)
3963 * - _sitename:key - site-scope key (e.g. wiktionary:meta)
3964 * - __global:key - global-scope key (e.g. __global:meta)
3965 * - __sites:dbname - site mapping (e.g. __sites:enwiki)
3967 * Sites mapping just specifies site name, other keys provide "local url"
3970 * @var bool|array|string
3972 $wgInterwikiCache = false;
3975 * Specify number of domains to check for messages.
3976 * - 1: Just wiki(db)-level
3977 * - 2: wiki and global levels
3980 $wgInterwikiScopes = 3;
3983 * Fallback site, if unable to resolve from cache
3985 $wgInterwikiFallbackSite = 'wiki';
3987 /** @} */ # end of Interwiki caching settings.
3990 * If local interwikis are set up which allow redirects,
3991 * set this regexp to restrict URLs which will be displayed
3992 * as 'redirected from' links.
3995 * It might look something like this:
3997 * $wgRedirectSources = '!^https?://[a-z-]+\.wikipedia\.org/!';
4000 * Leave at false to avoid displaying any incoming redirect markers.
4001 * This does not affect intra-wiki redirects, which don't change
4004 $wgRedirectSources = false;
4007 * Set this to false to avoid forcing the first letter of links to capitals.
4009 * @warning may break links! This makes links COMPLETELY case-sensitive. Links
4010 * appearing with a capital at the beginning of a sentence will *not* go to the
4011 * same place as links in the middle of a sentence using a lowercase initial.
4013 $wgCapitalLinks = true;
4016 * @since 1.16 - This can now be set per-namespace. Some special namespaces (such as Special, see
4017 * NamespaceInfo::$alwaysCapitalizedNamespaces for the full list) must be true by default (and
4018 * setting them has no effect), due to various things that require them to be so. Also, since Talk
4019 * namespaces need to directly mirror their associated content namespaces, the values for those are
4020 * ignored in favor of the subject namespace's setting. Setting for NS_MEDIA is taken automatically
4025 * $wgCapitalLinkOverrides[ NS_FILE ] = false;
4028 $wgCapitalLinkOverrides = [];
4031 * Which namespaces should support subpages?
4032 * See Language.php for a list of namespaces.
4034 $wgNamespacesWithSubpages = [
4037 NS_USER_TALK
=> true,
4039 NS_PROJECT_TALK
=> true,
4040 NS_FILE_TALK
=> true,
4041 NS_MEDIAWIKI
=> true,
4042 NS_MEDIAWIKI_TALK
=> true,
4043 NS_TEMPLATE
=> true,
4044 NS_TEMPLATE_TALK
=> true,
4046 NS_HELP_TALK
=> true,
4047 NS_CATEGORY_TALK
=> true
4051 * Array holding default tracking category names.
4053 * Array contains the system messages for each tracking category.
4054 * Tracking categories allow pages with certain characteristics to be tracked.
4055 * It works by adding any such page to a category automatically.
4057 * A message with the suffix '-desc' should be added as a description message
4058 * to have extra information on Special:TrackingCategories.
4060 * @deprecated since 1.25 Extensions should now register tracking categories using
4061 * the new extension registration system.
4065 $wgTrackingCategories = [];
4068 * Array of namespaces which can be deemed to contain valid "content", as far
4069 * as the site statistics are concerned. Useful if additional namespaces also
4070 * contain "content" which should be considered when generating a count of the
4071 * number of articles in the wiki.
4073 $wgContentNamespaces = [ NS_MAIN
];
4076 * Optional array of namespaces which should be blacklisted from Special:ShortPages
4077 * Only pages inside $wgContentNamespaces but not $wgShortPagesNamespaceBlacklist will
4078 * be shown on that page.
4081 $wgShortPagesNamespaceBlacklist = [];
4084 * Array of namespaces, in addition to the talk namespaces, where signatures
4085 * (~~~~) are likely to be used. This determines whether to display the
4086 * Signature button on the edit toolbar, and may also be used by extensions.
4087 * For example, "traditional" style wikis, where content and discussion are
4088 * intermixed, could place NS_MAIN and NS_PROJECT namespaces in this array.
4090 $wgExtraSignatureNamespaces = [];
4093 * Max number of redirects to follow when resolving redirects.
4094 * 1 means only the first redirect is followed (default behavior).
4095 * 0 or less means no redirects are followed.
4097 $wgMaxRedirects = 1;
4100 * Array of invalid page redirect targets.
4101 * Attempting to create a redirect to any of the pages in this array
4102 * will make the redirect fail.
4103 * Userlogout is hard-coded, so it does not need to be listed here.
4104 * (T12569) Disallow Mypage and Mytalk as well.
4106 * As of now, this only checks special pages. Redirects to pages in
4107 * other namespaces cannot be invalidated by this variable.
4109 $wgInvalidRedirectTargets = [ 'Filepath', 'Mypage', 'Mytalk', 'Redirect' ];
4111 /** @} */ # End of title and interwiki settings }
4113 /************************************************************************//**
4114 * @name Parser settings
4115 * These settings configure the transformation from wikitext to HTML.
4120 * Parser configuration. Associative array with the following members:
4122 * class The class name
4124 * preprocessorClass The preprocessor class. Two classes are currently available:
4125 * Preprocessor_Hash, which uses plain PHP arrays for temporary
4126 * storage, and Preprocessor_DOM, which uses the DOM module for
4127 * temporary storage. Preprocessor_DOM generally uses less memory;
4128 * the speed of the two is roughly the same.
4130 * If this parameter is not given, it uses Preprocessor_Hash.
4132 * The Preprocessor_DOM class is deprecated, and will be removed in a future
4135 * The entire associative array will be passed through to the constructor as
4136 * the first parameter. Note that only Setup.php can use this variable --
4137 * the configuration will change at runtime via Parser member functions, so
4138 * the contents of this variable will be out-of-date. The variable can only be
4139 * changed during LocalSettings.php, in particular, it can't be changed during
4140 * an extension setup function.
4143 'class' => Parser
::class,
4144 # 'preprocessorClass' => Preprocessor_Hash::class,
4148 * Maximum indent level of toc.
4150 $wgMaxTocLevel = 999;
4153 * A complexity limit on template expansion: the maximum number of nodes visited
4154 * by PPFrame::expand()
4156 $wgMaxPPNodeCount = 1000000;
4159 * A complexity limit on template expansion: the maximum number of elements
4160 * generated by Preprocessor::preprocessToObj(). This allows you to limit the
4161 * amount of memory used by the Preprocessor_DOM node cache: testing indicates
4162 * that each element uses about 160 bytes of memory on a 64-bit processor, so
4163 * this default corresponds to about 155 MB.
4165 * When the limit is exceeded, an exception is thrown.
4167 $wgMaxGeneratedPPNodeCount = 1000000;
4170 * Maximum recursion depth for templates within templates.
4171 * The current parser adds two levels to the PHP call stack for each template,
4172 * and xdebug limits the call stack to 100 by default. So this should hopefully
4173 * stop the parser before it hits the xdebug limit.
4175 $wgMaxTemplateDepth = 40;
4178 * @see $wgMaxTemplateDepth
4180 $wgMaxPPExpandDepth = 40;
4183 * URL schemes that should be recognized as valid by wfParseUrl().
4185 * WARNING: Do not add 'file:' to this or internal file links will be broken.
4186 * Instead, if you want to support file links, add 'file://'. The same applies
4187 * to any other protocols with the same name as a namespace. See task T46011 for
4193 'bitcoin:', 'ftp://', 'ftps://', 'geo:', 'git://', 'gopher://', 'http://',
4194 'https://', 'irc://', 'ircs://', 'magnet:', 'mailto:', 'mms://', 'news:',
4195 'nntp://', 'redis://', 'sftp://', 'sip:', 'sips:', 'sms:', 'ssh://',
4196 'svn://', 'tel:', 'telnet://', 'urn:', 'worldwind://', 'xmpp:', '//'
4200 * If true, removes (by substituting) templates in signatures.
4202 $wgCleanSignatures = true;
4205 * Whether to allow inline image pointing to other websites
4207 $wgAllowExternalImages = false;
4210 * If the above is false, you can specify an exception here. Image URLs
4211 * that start with this string are then rendered, while all others are not.
4212 * You can use this to set up a trusted, simple repository of images.
4213 * You may also specify an array of strings to allow multiple sites
4217 * $wgAllowExternalImagesFrom = 'http://127.0.0.1/';
4218 * $wgAllowExternalImagesFrom = [ 'http://127.0.0.1/', 'http://example.com' ];
4221 $wgAllowExternalImagesFrom = '';
4224 * If $wgAllowExternalImages is false, you can allow an on-wiki
4225 * whitelist of regular expression fragments to match the image URL
4226 * against. If the image matches one of the regular expression fragments,
4227 * The image will be displayed.
4229 * Set this to true to enable the on-wiki whitelist (MediaWiki:External image whitelist)
4230 * Or false to disable it
4234 $wgEnableImageWhitelist = false;
4237 * A different approach to the above: simply allow the "<img>" tag to be used.
4238 * This allows you to specify alt text and other attributes, copy-paste HTML to
4239 * your wiki more easily, etc. However, allowing external images in any manner
4240 * will allow anyone with editing rights to snoop on your visitors' IP
4241 * addresses and so forth, if they wanted to, by inserting links to images on
4242 * sites they control.
4244 $wgAllowImageTag = false;
4247 * Configuration for HTML postprocessing tool. Set this to a configuration
4248 * array to enable an external tool. By default, we now use the RemexHtml
4249 * library; historically, other postprocessors were used.
4251 * Setting this to null will use default settings.
4254 * - driver: formerly used to select a postprocessor; now ignored.
4255 * - treeMutationTrace: a boolean to turn on Remex tracing
4256 * - serializerTrace: a boolean to turn on Remex tracing
4257 * - mungerTrace: a boolean to turn on Remex tracing
4258 * - pwrap: whether <p> wrapping should be done (default true)
4260 * See includes/tidy/RemexDriver.php for detail on configuration.
4262 * Overriding the default configuration is strongly discouraged in
4265 $wgTidyConfig = [ 'driver' => 'RemexHtml' ];
4268 * Allow raw, unchecked HTML in "<html>...</html>" sections.
4269 * THIS IS VERY DANGEROUS on a publicly editable site, so USE wgGroupPermissions
4270 * TO RESTRICT EDITING to only those that you trust
4275 * Set a default target for external links, e.g. _blank to pop up a new window.
4277 * This will also set the "noreferrer" and "noopener" link rel to prevent the
4278 * attack described at https://mathiasbynens.github.io/rel-noopener/ .
4279 * Some older browsers may not support these link attributes, hence
4280 * setting $wgExternalLinkTarget to _blank may represent a security risk
4281 * to some of your users.
4283 $wgExternalLinkTarget = false;
4286 * If true, external URL links in wiki text will be given the
4287 * rel="nofollow" attribute as a hint to search engines that
4288 * they should not be followed for ranking purposes as they
4289 * are user-supplied and thus subject to spamming.
4291 $wgNoFollowLinks = true;
4294 * Namespaces in which $wgNoFollowLinks doesn't apply.
4295 * See Language.php for a list of namespaces.
4297 $wgNoFollowNsExceptions = [];
4300 * If this is set to an array of domains, external links to these domain names
4301 * (or any subdomains) will not be set to rel="nofollow" regardless of the
4302 * value of $wgNoFollowLinks. For instance:
4304 * $wgNoFollowDomainExceptions = [ 'en.wikipedia.org', 'wiktionary.org', 'mediawiki.org' ];
4306 * This would add rel="nofollow" to links to de.wikipedia.org, but not
4307 * en.wikipedia.org, wiktionary.org, en.wiktionary.org, us.en.wikipedia.org,
4310 * Defaults to mediawiki.org for the links included in the software by default.
4312 $wgNoFollowDomainExceptions = [ 'mediawiki.org' ];
4315 * Allow DISPLAYTITLE to change title display
4317 $wgAllowDisplayTitle = true;
4320 * For consistency, restrict DISPLAYTITLE to text that normalizes to the same
4321 * canonical DB key. Also disallow some inline CSS rules like display: none;
4322 * which can cause the text to be hidden or unselectable.
4324 $wgRestrictDisplayTitle = true;
4327 * Maximum number of calls per parse to expensive parser functions such as
4330 $wgExpensiveParserFunctionLimit = 100;
4333 * Preprocessor caching threshold
4334 * Setting it to 'false' will disable the preprocessor cache.
4336 $wgPreprocessorCacheThreshold = 1000;
4339 * Enable interwiki transcluding. Only when iw_trans=1 in the interwiki table.
4341 $wgEnableScaryTranscluding = false;
4344 * Expiry time for transcluded templates cached in object cache.
4345 * Only used $wgEnableInterwikiTranscluding is set to true.
4347 $wgTranscludeCacheExpiry = 3600;
4350 * Enable the magic links feature of automatically turning ISBN xxx,
4351 * PMID xxx, RFC xxx into links
4355 $wgEnableMagicLinks = [
4361 /** @} */ # end of parser settings }
4363 /************************************************************************//**
4369 * Method used to determine if a page in a content namespace should be counted
4370 * as a valid article.
4372 * Redirect pages will never be counted as valid articles.
4374 * This variable can have the following values:
4375 * - 'any': all pages as considered as valid articles
4376 * - 'link': the page must contain a [[wiki link]] to be considered valid
4378 * See also See https://www.mediawiki.org/wiki/Manual:Article_count
4380 * Retroactively changing this variable will not affect the existing count,
4381 * to update it, you will need to run the maintenance/updateArticleCount.php
4384 $wgArticleCountMethod = 'link';
4387 * How many days user must be idle before he is considered inactive. Will affect
4388 * the number shown on Special:Statistics, Special:ActiveUsers, and the
4389 * {{NUMBEROFACTIVEUSERS}} magic word in wikitext.
4390 * You might want to leave this as the default value, to provide comparable
4391 * numbers between different wikis.
4393 $wgActiveUserDays = 30;
4395 /** @} */ # End of statistics }
4397 /************************************************************************//**
4398 * @name User accounts, authentication
4403 * Central ID lookup providers
4404 * Key is the provider ID, value is a specification for ObjectFactory
4407 $wgCentralIdLookupProviders = [
4408 'local' => [ 'class' => LocalIdLookup
::class ],
4412 * Central ID lookup provider to use by default
4415 $wgCentralIdLookupProvider = 'local';
4418 * Password policy for the wiki.
4421 * 'policies' => [ <group> => [ <policy> => <settings>, ... ], ... ],
4422 * 'checks' => [ <policy> => <callback>, ... ],
4424 * where <group> is a user group, <policy> is a password policy name
4425 * (arbitrary string) defined in the 'checks' part, <callback> is the
4426 * PHP callable implementing the policy check, <settings> is an array
4427 * of options with the following keys:
4428 * - value: (number, boolean or null) the value to pass to the callback
4429 * - forceChange: (bool, default false) if the password is invalid, do
4430 * not let the user log in without changing the password
4431 * - suggestChangeOnLogin: (bool, default false) if true and the password is
4432 * invalid, suggest a password change if logging in. If all the failing policies
4433 * that apply to the user have this set to false, the password change
4434 * screen will not be shown. 'forceChange' takes precedence over
4435 * 'suggestChangeOnLogin' if they are both present.
4436 * As a shorthand for [ 'value' => <value> ], simply <value> can be written.
4437 * When multiple password policies are defined for a user, the settings
4438 * arrays are merged, and for fields which are set in both arrays, the
4439 * larger value (as understood by PHP's 'max' method) is taken.
4441 * A user's effective policy is the superset of all policy statements
4442 * from the policies for the groups where the user is a member. If more
4443 * than one group policy include the same policy statement, the value is
4444 * the max() of the values. Note true > false. The 'default' policy group
4445 * is required, and serves as the minimum policy for all users.
4447 * Callbacks receive three arguments: the policy value, the User object
4448 * and the password; and must return a StatusValue. A non-good status
4449 * means the password will not be accepted for new accounts, and existing
4450 * accounts will be prompted for password change or barred from logging in
4451 * (depending on whether the status is a fatal or merely error/warning).
4453 * The checks supported by core are:
4454 * - MinimalPasswordLength - Minimum length a user can set.
4455 * - MinimumPasswordLengthToLogin - Passwords shorter than this will
4456 * not be allowed to login, regardless if it is correct.
4457 * - MaximalPasswordLength - maximum length password a user is allowed
4458 * to attempt. Prevents DoS attacks with pbkdf2.
4459 * - PasswordCannotMatchUsername - Password cannot match the username.
4460 * - PasswordCannotMatchBlacklist - Username/password combination cannot
4461 * match a blacklist of default passwords used by MediaWiki in the past.
4462 * - PasswordCannotBePopular - Blacklist passwords which are known to be
4463 * commonly chosen. Set to integer n to ban the top n passwords.
4464 * If you want to ban all common passwords on file, use the
4465 * PHP_INT_MAX constant.
4466 * Deprecated since 1.33. Use PasswordNotInLargeBlacklist instead.
4467 * - PasswordNotInLargeBlacklist - Password not in best practices list of
4468 * 100,000 commonly used passwords. Due to the size of the list this
4469 * is a probabilistic test.
4471 * If you add custom checks, for Special:PasswordPolicies to display them correctly,
4472 * every check should have a corresponding passwordpolicies-policy-<check> message,
4473 * and every settings field other than 'value' should have a corresponding
4474 * passwordpolicies-policyflag-<flag> message (<check> and <flag> are in lowercase).
4475 * The check message receives the policy value as a parameter, the flag message
4476 * receives the flag value (or values if it's an array).
4479 * @see PasswordPolicyChecks
4480 * @see User::checkPasswordValidity()
4482 $wgPasswordPolicy = [
4485 'MinimalPasswordLength' => 10,
4486 'MinimumPasswordLengthToLogin' => 1,
4487 'PasswordNotInLargeBlacklist' => true,
4490 'MinimalPasswordLength' => 10,
4491 'MinimumPasswordLengthToLogin' => 1,
4492 'PasswordNotInLargeBlacklist' => true,
4494 'interface-admin' => [
4495 'MinimalPasswordLength' => 10,
4496 'MinimumPasswordLengthToLogin' => 1,
4497 'PasswordNotInLargeBlacklist' => true,
4500 'MinimalPasswordLength' => 10,
4501 'MinimumPasswordLengthToLogin' => 1,
4502 'PasswordNotInLargeBlacklist' => true,
4505 'MinimalPasswordLength' => [ 'value' => 1, 'suggestChangeOnLogin' => true ],
4506 'PasswordCannotMatchUsername' => [ 'value' => true, 'suggestChangeOnLogin' => true ],
4507 'PasswordCannotMatchBlacklist' => [ 'value' => true, 'suggestChangeOnLogin' => true ],
4508 'MaximalPasswordLength' => [ 'value' => 4096, 'suggestChangeOnLogin' => true ],
4512 'MinimalPasswordLength' => 'PasswordPolicyChecks::checkMinimalPasswordLength',
4513 'MinimumPasswordLengthToLogin' => 'PasswordPolicyChecks::checkMinimumPasswordLengthToLogin',
4514 'PasswordCannotMatchUsername' => 'PasswordPolicyChecks::checkPasswordCannotMatchUsername',
4515 'PasswordCannotMatchBlacklist' => 'PasswordPolicyChecks::checkPasswordCannotMatchBlacklist',
4516 'MaximalPasswordLength' => 'PasswordPolicyChecks::checkMaximalPasswordLength',
4517 'PasswordCannotBePopular' => 'PasswordPolicyChecks::checkPopularPasswordBlacklist',
4518 'PasswordNotInLargeBlacklist' => 'PasswordPolicyChecks::checkPasswordNotInLargeBlacklist',
4523 * Configure AuthManager
4525 * All providers are constructed using ObjectFactory, see that for the general
4526 * structure. The array may also contain a key "sort" used to order providers:
4527 * providers are stably sorted by this value, which should be an integer
4531 * - preauth: Array (keys ignored) of specifications for PreAuthenticationProviders
4532 * - primaryauth: Array (keys ignored) of specifications for PrimaryAuthenticationProviders
4533 * - secondaryauth: Array (keys ignored) of specifications for SecondaryAuthenticationProviders
4536 * @note If this is null or empty, the value from $wgAuthManagerAutoConfig is
4537 * used instead. Local customization should generally set this variable from
4538 * scratch to the desired configuration. Extensions that want to
4539 * auto-configure themselves should use $wgAuthManagerAutoConfig instead.
4541 $wgAuthManagerConfig = null;
4544 * @see $wgAuthManagerConfig
4547 $wgAuthManagerAutoConfig = [
4549 MediaWiki\Auth\ThrottlePreAuthenticationProvider
::class => [
4550 'class' => MediaWiki\Auth\ThrottlePreAuthenticationProvider
::class,
4555 // TemporaryPasswordPrimaryAuthenticationProvider should come before
4556 // any other PasswordAuthenticationRequest-based
4557 // PrimaryAuthenticationProvider (or at least any that might return
4558 // FAIL rather than ABSTAIN for a wrong password), or password reset
4559 // won't work right. Do not remove this (or change the key) or
4560 // auto-configuration of other such providers in extensions will
4561 // probably auto-insert themselves in the wrong place.
4562 MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider
::class => [
4563 'class' => MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider
::class,
4565 // Fall through to LocalPasswordPrimaryAuthenticationProvider
4566 'authoritative' => false,
4570 MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider
::class => [
4571 'class' => MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider
::class,
4573 // Last one should be authoritative, or else the user will get
4574 // a less-than-helpful error message (something like "supplied
4575 // authentication info not supported" rather than "wrong
4576 // password") if it too fails.
4577 'authoritative' => true,
4582 'secondaryauth' => [
4583 MediaWiki\Auth\CheckBlocksSecondaryAuthenticationProvider
::class => [
4584 'class' => MediaWiki\Auth\CheckBlocksSecondaryAuthenticationProvider
::class,
4587 MediaWiki\Auth\ResetPasswordSecondaryAuthenticationProvider
::class => [
4588 'class' => MediaWiki\Auth\ResetPasswordSecondaryAuthenticationProvider
::class,
4591 // Linking during login is experimental, enable at your own risk - T134952
4592 // MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider::class => [
4593 // 'class' => MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider::class,
4596 MediaWiki\Auth\EmailNotificationSecondaryAuthenticationProvider
::class => [
4597 'class' => MediaWiki\Auth\EmailNotificationSecondaryAuthenticationProvider
::class,
4604 * Time frame for re-authentication.
4606 * With only password-based authentication, you'd just ask the user to re-enter
4607 * their password to verify certain operations like changing the password or
4608 * changing the account's email address. But under AuthManager, the user might
4609 * not have a password (you might even have to redirect the browser to a
4610 * third-party service or something complex like that), you might want to have
4611 * both factors of a two-factor authentication, and so on. So, the options are:
4612 * - Incorporate the whole multi-step authentication flow within everything
4613 * that needs to do this.
4614 * - Consider it good if they used Special:UserLogin during this session within
4615 * the last X seconds.
4616 * - Come up with a third option.
4618 * MediaWiki currently takes the second option. This setting configures the
4621 * This allows for configuring different time frames for different
4622 * "operations". The operations used in MediaWiki core include:
4625 * - ChangeCredentials
4626 * - RemoveCredentials
4629 * Additional operations may be used by extensions, either explicitly by
4630 * calling AuthManager::securitySensitiveOperationStatus(),
4631 * ApiAuthManagerHelper::securitySensitiveOperation() or
4632 * SpecialPage::checkLoginSecurityLevel(), or implicitly by overriding
4633 * SpecialPage::getLoginSecurityLevel() or by subclassing
4634 * AuthManagerSpecialPage.
4636 * The key 'default' is used if a requested operation isn't defined in the array.
4639 * @var int[] operation => time in seconds. A 'default' key must always be provided.
4641 $wgReauthenticateTime = [
4646 * Whether to allow security-sensitive operations when re-authentication is not possible.
4648 * If AuthManager::canAuthenticateNow() is false (e.g. the current
4649 * SessionProvider is not able to change users, such as when OAuth is in use),
4650 * AuthManager::securitySensitiveOperationStatus() cannot sensibly return
4651 * SEC_REAUTH. Setting an operation true here will have it return SEC_OK in
4652 * that case, while setting it false will have it return SEC_FAIL.
4654 * The key 'default' is used if a requested operation isn't defined in the array.
4657 * @see $wgReauthenticateTime
4658 * @var bool[] operation => boolean. A 'default' key must always be provided.
4660 $wgAllowSecuritySensitiveOperationIfCannotReauthenticate = [
4665 * List of AuthenticationRequest class names which are not changeable through
4666 * Special:ChangeCredentials and the changeauthenticationdata API.
4667 * This is only enforced on the client level; AuthManager itself (e.g.
4668 * AuthManager::allowsAuthenticationDataChange calls) is not affected.
4669 * Class names are checked for exact match (not for subclasses).
4673 $wgChangeCredentialsBlacklist = [
4674 \MediaWiki\Auth\TemporaryPasswordAuthenticationRequest
::class
4678 * List of AuthenticationRequest class names which are not removable through
4679 * Special:RemoveCredentials and the removeauthenticationdata API.
4680 * This is only enforced on the client level; AuthManager itself (e.g.
4681 * AuthManager::allowsAuthenticationDataChange calls) is not affected.
4682 * Class names are checked for exact match (not for subclasses).
4686 $wgRemoveCredentialsBlacklist = [
4687 \MediaWiki\Auth\PasswordAuthenticationRequest
::class,
4691 * Specifies the minimal length of a user password. If set to 0, empty pass-
4692 * words are allowed.
4693 * @deprecated since 1.26, use $wgPasswordPolicy's MinimalPasswordLength.
4695 $wgMinimalPasswordLength = false;
4698 * Specifies the maximal length of a user password (T64685).
4700 * It is not recommended to make this greater than the default, as it can
4701 * allow DoS attacks by users setting really long passwords. In addition,
4702 * this should not be lowered too much, as it enforces weak passwords.
4704 * @warning Unlike other password settings, user with passwords greater than
4705 * the maximum will not be able to log in.
4706 * @deprecated since 1.26, use $wgPasswordPolicy's MaximalPasswordLength.
4708 $wgMaximalPasswordLength = false;
4711 * Specifies if users should be sent to a password-reset form on login, if their
4712 * password doesn't meet the requirements of User::isValidPassword().
4715 $wgInvalidPasswordReset = true;
4718 * Default password type to use when hashing user passwords
4722 $wgPasswordDefault = 'pbkdf2';
4725 * Configuration for built-in password types. Maps the password type
4726 * to an array of options. The 'class' option is the Password class to
4727 * use. All other options are class-dependent.
4729 * An advanced example:
4731 * $wgPasswordConfig['bcrypt-peppered'] = [
4732 * 'class' => EncryptedPassword::class,
4733 * 'underlying' => 'bcrypt',
4735 * hash( 'sha256', 'secret', true ),
4737 * 'cipher' => 'aes-256-cbc',
4743 $wgPasswordConfig = [
4745 'class' => MWOldPassword
::class,
4748 'class' => MWSaltedPassword
::class,
4750 'pbkdf2-legacyA' => [
4751 'class' => LayeredParameterizedPassword
::class,
4757 'pbkdf2-legacyB' => [
4758 'class' => LayeredParameterizedPassword
::class,
4765 'class' => BcryptPassword
::class,
4769 'class' => Pbkdf2Password
::class,
4775 'class' => Argon2Password
::class,
4778 // * 'argon2i' is optimized against side-channel attacks (PHP 7.2+)
4779 // * 'argon2id' is optimized against both side-channel and GPU cracking (PHP 7.3+)
4780 // * 'auto' to use best available algorithm. If you're using more than one server, be
4781 // careful when you're mixing PHP versions because newer PHP might generate hashes that
4782 // older versions might would not understand.
4785 // The parameters below are the same as options accepted by password_hash().
4786 // Set them to override that function's defaults.
4788 // 'memory_cost' => PASSWORD_ARGON2_DEFAULT_MEMORY_COST,
4789 // 'time_cost' => PASSWORD_ARGON2_DEFAULT_TIME_COST,
4790 // 'threads' => PASSWORD_ARGON2_DEFAULT_THREADS,
4795 * Whether to allow password resets ("enter some identifying data, and we'll send an email
4796 * with a temporary password you can use to get back into the account") identified by
4797 * various bits of data. Setting all of these to false (or the whole variable to false)
4798 * has the effect of disabling password resets entirely
4800 $wgPasswordResetRoutes = [
4806 * Maximum number of Unicode characters in signature
4808 $wgMaxSigChars = 255;
4811 * Maximum number of bytes in username. You want to run the maintenance
4812 * script ./maintenance/checkUsernames.php once you have changed this value.
4814 $wgMaxNameChars = 255;
4817 * Array of usernames which may not be registered or logged in from
4818 * Maintenance scripts can still use these
4820 $wgReservedUsernames = [
4821 'MediaWiki default', // Default 'Main Page' and MediaWiki: message pages
4822 'Conversion script', // Used for the old Wikipedia software upgrade
4823 'Maintenance script', // Maintenance scripts which perform editing, image import script
4824 'Template namespace initialisation script', // Used in 1.2->1.3 upgrade
4825 'ScriptImporter', // Default user name used by maintenance/importSiteScripts.php
4826 'Unknown user', // Used in WikiImporter and RevisionStore for revisions with no author
4827 'msg:double-redirect-fixer', // Automatic double redirect fix
4828 'msg:usermessage-editor', // Default user for leaving user messages
4829 'msg:proxyblocker', // For $wgProxyList and Special:Blockme (removed in 1.22)
4830 'msg:sorbs', // For $wgEnableDnsBlacklist etc.
4831 'msg:spambot_username', // Used by cleanupSpam.php
4832 'msg:autochange-username', // Used by anon category RC entries (parser functions, Lua & purges)
4836 * Settings added to this array will override the default globals for the user
4837 * preferences used by anonymous visitors and newly created accounts.
4838 * For instance, to disable editing on double clicks:
4839 * $wgDefaultUserOptions ['editondblclick'] = 0;
4841 $wgDefaultUserOptions = [
4842 'ccmeonemails' => 0,
4843 'cols' => 80, // @deprecated since 1.29 No longer used in core
4844 'date' => 'default',
4847 'editfont' => 'monospace',
4848 'editondblclick' => 0,
4849 'editsectiononrightclick' => 0,
4850 'email-allow-new-users' => 1,
4851 'enotifminoredits' => 0,
4852 'enotifrevealaddr' => 0,
4853 'enotifusertalkpages' => 1,
4854 'enotifwatchlistpages' => 1,
4855 'extendwatchlist' => 1,
4857 'forceeditsummary' => 0,
4858 'gender' => 'unknown',
4860 'hidepatrolled' => 0,
4861 'hidecategorization' => 1,
4863 'minordefault' => 0,
4864 'newpageshidepatrolled' => 0,
4866 'norollbackdiff' => 0,
4867 'numberheadings' => 0,
4868 'previewonfirst' => 0,
4869 'previewontop' => 1,
4871 'rcenhancedfilters-disable' => 0,
4873 'rows' => 25, // @deprecated since 1.29 No longer used in core
4874 'showhiddencats' => 0,
4875 'shownumberswatching' => 1,
4876 'showrollbackconfirmation' => 0,
4878 'stubthreshold' => 0,
4881 'uselivepreview' => 0,
4883 'watchcreations' => 1,
4884 'watchdefault' => 1,
4885 'watchdeletion' => 0,
4886 'watchuploads' => 1,
4887 'watchlistdays' => 7.0,
4888 'watchlisthideanons' => 0,
4889 'watchlisthidebots' => 0,
4890 'watchlisthideliu' => 0,
4891 'watchlisthideminor' => 0,
4892 'watchlisthideown' => 0,
4893 'watchlisthidepatrolled' => 0,
4894 'watchlisthidecategorization' => 1,
4895 'watchlistreloadautomatically' => 0,
4896 'watchlistunwatchlinks' => 0,
4898 'watchrollback' => 0,
4899 'wlenhancedfilters-disable' => 0,
4901 'useeditwarning' => 1,
4902 'prefershttps' => 1,
4906 * An array of preferences to not show for the user
4908 $wgHiddenPrefs = [];
4911 * Characters to prevent during new account creations.
4912 * This is used in a regular expression character class during
4913 * registration (regex metacharacters like / are escaped).
4915 $wgInvalidUsernameCharacters = '@:';
4918 * Character used as a delimiter when testing for interwiki userrights
4919 * (In Special:UserRights, it is possible to modify users on different
4920 * databases if the delimiter is used, e.g. "Someuser@enwiki").
4922 * It is recommended that you have this delimiter in
4923 * $wgInvalidUsernameCharacters above, or you will not be able to
4924 * modify the user rights of those users via Special:UserRights
4926 $wgUserrightsInterwikiDelimiter = '@';
4929 * This is to let user authenticate using https when they come from http.
4930 * Based on an idea by George Herbert on wikitech-l:
4931 * https://lists.wikimedia.org/pipermail/wikitech-l/2010-October/050039.html
4934 $wgSecureLogin = false;
4937 * Versioning for authentication tokens.
4939 * If non-null, this is combined with the user's secret (the user_token field
4940 * in the DB) to generate the token cookie. Changing this will invalidate all
4941 * active sessions (i.e. it will log everyone out).
4946 $wgAuthenticationTokenVersion = null;
4949 * MediaWiki\Session\SessionProvider configuration.
4951 * Value is an array of ObjectFactory specifications for the SessionProviders
4952 * to be used. Keys in the array are ignored. Order is not significant.
4956 $wgSessionProviders = [
4957 MediaWiki\Session\CookieSessionProvider
::class => [
4958 'class' => MediaWiki\Session\CookieSessionProvider
::class,
4961 'callUserSetCookiesHook' => true,
4964 MediaWiki\Session\BotPasswordSessionProvider
::class => [
4965 'class' => MediaWiki\Session\BotPasswordSessionProvider
::class,
4972 /** @} */ # end user accounts }
4974 /************************************************************************//**
4975 * @name User rights, access control and monitoring
4980 * Number of seconds before autoblock entries expire. Default 86400 = 1 day.
4982 $wgAutoblockExpiry = 86400;
4985 * Set this to true to allow blocked users to edit their own user talk page.
4987 * This only applies to sitewide blocks. Partial blocks always allow users to
4988 * edit their own user talk page unless otherwise specified in the block
4991 $wgBlockAllowsUTEdit = true;
4994 * Allow sysops to ban users from accessing Emailuser
4996 $wgSysopEmailBans = true;
4999 * Limits on the possible sizes of range blocks.
5001 * CIDR notation is hard to understand, it's easy to mistakenly assume that a
5002 * /1 is a small range and a /31 is a large range. For IPv4, setting a limit of
5003 * half the number of bits avoids such errors, and allows entire ISPs to be
5004 * blocked using a small number of range blocks.
5006 * For IPv6, RFC 3177 recommends that a /48 be allocated to every residential
5007 * customer, so range blocks larger than /64 (half the number of bits) will
5008 * plainly be required. RFC 4692 implies that a very large ISP may be
5009 * allocated a /19 if a generous HD-Ratio of 0.8 is used, so we will use that
5010 * as our limit. As of 2012, blocking the whole world would require a /4 range.
5012 $wgBlockCIDRLimit = [
5013 'IPv4' => 16, # Blocks larger than a /16 (64k addresses) will not be allowed
5018 * If true, blocked users will not be allowed to login. When using this with
5019 * a public wiki, the effect of logging out blocked users may actually be
5020 * avers: unless the user's address is also blocked (e.g. auto-block),
5021 * logging the user out will again allow reading and editing, just as for
5022 * anonymous visitors.
5024 $wgBlockDisablesLogin = false;
5027 * Pages anonymous user may see, set as an array of pages titles.
5031 * $wgWhitelistRead = array ( "Main Page", "Wikipedia:Help");
5034 * Special:Userlogin and Special:ChangePassword are always whitelisted.
5036 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
5037 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
5039 * @note Also that this will only protect _pages in the wiki_. Uploaded files
5040 * will remain readable. You can use img_auth.php to protect uploaded files,
5041 * see https://www.mediawiki.org/wiki/Manual:Image_Authorization
5043 * @note Extensions should not modify this, but use the TitleReadWhitelist
5046 $wgWhitelistRead = false;
5049 * Pages anonymous user may see, set as an array of regular expressions.
5051 * This function will match the regexp against the title name, which
5052 * is without underscore.
5055 * To whitelist [[Main Page]]:
5057 * $wgWhitelistReadRegexp = [ "/Main Page/" ];
5060 * @note Unless ^ and/or $ is specified, a regular expression might match
5061 * pages not intended to be whitelisted. The above example will also
5062 * whitelist a page named 'Security Main Page'.
5065 * To allow reading any page starting with 'User' regardless of the case:
5067 * $wgWhitelistReadRegexp = [ "@^UsEr.*@i" ];
5069 * Will allow both [[User is banned]] and [[User:JohnDoe]]
5071 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
5072 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
5074 $wgWhitelistReadRegexp = false;
5077 * Should editors be required to have a validated e-mail
5078 * address before being allowed to edit?
5080 $wgEmailConfirmToEdit = false;
5083 * Should MediaWiki attempt to protect user's privacy when doing redirects?
5084 * Keep this true if access counts to articles are made public.
5086 $wgHideIdentifiableRedirects = true;
5089 * Permission keys given to users in each group.
5091 * This is an array where the keys are all groups and each value is an
5092 * array of the format (right => boolean).
5094 * The second format is used to support per-namespace permissions.
5095 * Note that this feature does not fully work for all permission types.
5097 * All users are implicitly in the '*' group including anonymous visitors;
5098 * logged-in users are all implicitly in the 'user' group. These will be
5099 * combined with the permissions of all groups that a given user is listed
5100 * in in the user_groups table.
5102 * Note: Don't set $wgGroupPermissions = []; unless you know what you're
5103 * doing! This will wipe all permissions, and may mean that your users are
5104 * unable to perform certain essential tasks or access new functionality
5105 * when new permissions are introduced and default grants established.
5107 * Functionality to make pages inaccessible has not been extensively tested
5108 * for security. Use at your own risk!
5110 * This replaces $wgWhitelistAccount and $wgWhitelistEdit
5112 $wgGroupPermissions = [];
5114 /** @cond file_level_code */
5115 // Implicit group for all visitors
5116 $wgGroupPermissions['*']['createaccount'] = true;
5117 $wgGroupPermissions['*']['read'] = true;
5118 $wgGroupPermissions['*']['edit'] = true;
5119 $wgGroupPermissions['*']['createpage'] = true;
5120 $wgGroupPermissions['*']['createtalk'] = true;
5121 $wgGroupPermissions['*']['writeapi'] = true;
5122 $wgGroupPermissions['*']['viewmywatchlist'] = true;
5123 $wgGroupPermissions['*']['editmywatchlist'] = true;
5124 $wgGroupPermissions['*']['viewmyprivateinfo'] = true;
5125 $wgGroupPermissions['*']['editmyprivateinfo'] = true;
5126 $wgGroupPermissions['*']['editmyoptions'] = true;
5127 # $wgGroupPermissions['*']['patrolmarks'] = false; // let anons see what was patrolled
5129 // Implicit group for all logged-in accounts
5130 $wgGroupPermissions['user']['move'] = true;
5131 $wgGroupPermissions['user']['move-subpages'] = true;
5132 $wgGroupPermissions['user']['move-rootuserpages'] = true; // can move root userpages
5133 $wgGroupPermissions['user']['move-categorypages'] = true;
5134 $wgGroupPermissions['user']['movefile'] = true;
5135 $wgGroupPermissions['user']['read'] = true;
5136 $wgGroupPermissions['user']['edit'] = true;
5137 $wgGroupPermissions['user']['createpage'] = true;
5138 $wgGroupPermissions['user']['createtalk'] = true;
5139 $wgGroupPermissions['user']['writeapi'] = true;
5140 $wgGroupPermissions['user']['upload'] = true;
5141 $wgGroupPermissions['user']['reupload'] = true;
5142 $wgGroupPermissions['user']['reupload-shared'] = true;
5143 $wgGroupPermissions['user']['minoredit'] = true;
5144 $wgGroupPermissions['user']['editmyusercss'] = true;
5145 $wgGroupPermissions['user']['editmyuserjson'] = true;
5146 $wgGroupPermissions['user']['editmyuserjs'] = true;
5147 $wgGroupPermissions['user']['editmyuserjsredirect'] = true;
5148 $wgGroupPermissions['user']['purge'] = true;
5149 $wgGroupPermissions['user']['sendemail'] = true;
5150 $wgGroupPermissions['user']['applychangetags'] = true;
5151 $wgGroupPermissions['user']['changetags'] = true;
5152 $wgGroupPermissions['user']['editcontentmodel'] = true;
5154 // Implicit group for accounts that pass $wgAutoConfirmAge
5155 $wgGroupPermissions['autoconfirmed']['autoconfirmed'] = true;
5156 $wgGroupPermissions['autoconfirmed']['editsemiprotected'] = true;
5158 // Users with bot privilege can have their edits hidden
5159 // from various log pages by default
5160 $wgGroupPermissions['bot']['bot'] = true;
5161 $wgGroupPermissions['bot']['autoconfirmed'] = true;
5162 $wgGroupPermissions['bot']['editsemiprotected'] = true;
5163 $wgGroupPermissions['bot']['nominornewtalk'] = true;
5164 $wgGroupPermissions['bot']['autopatrol'] = true;
5165 $wgGroupPermissions['bot']['suppressredirect'] = true;
5166 $wgGroupPermissions['bot']['apihighlimits'] = true;
5167 $wgGroupPermissions['bot']['writeapi'] = true;
5169 // Most extra permission abilities go to this group
5170 $wgGroupPermissions['sysop']['block'] = true;
5171 $wgGroupPermissions['sysop']['createaccount'] = true;
5172 $wgGroupPermissions['sysop']['delete'] = true;
5173 // can be separately configured for pages with > $wgDeleteRevisionsLimit revs
5174 $wgGroupPermissions['sysop']['bigdelete'] = true;
5175 // can view deleted history entries, but not see or restore the text
5176 $wgGroupPermissions['sysop']['deletedhistory'] = true;
5177 // can view deleted revision text
5178 $wgGroupPermissions['sysop']['deletedtext'] = true;
5179 $wgGroupPermissions['sysop']['undelete'] = true;
5180 $wgGroupPermissions['sysop']['editinterface'] = true;
5181 $wgGroupPermissions['sysop']['editsitejson'] = true;
5182 $wgGroupPermissions['sysop']['edituserjson'] = true;
5183 $wgGroupPermissions['sysop']['import'] = true;
5184 $wgGroupPermissions['sysop']['importupload'] = true;
5185 $wgGroupPermissions['sysop']['move'] = true;
5186 $wgGroupPermissions['sysop']['move-subpages'] = true;
5187 $wgGroupPermissions['sysop']['move-rootuserpages'] = true;
5188 $wgGroupPermissions['sysop']['move-categorypages'] = true;
5189 $wgGroupPermissions['sysop']['patrol'] = true;
5190 $wgGroupPermissions['sysop']['autopatrol'] = true;
5191 $wgGroupPermissions['sysop']['protect'] = true;
5192 $wgGroupPermissions['sysop']['editprotected'] = true;
5193 $wgGroupPermissions['sysop']['rollback'] = true;
5194 $wgGroupPermissions['sysop']['upload'] = true;
5195 $wgGroupPermissions['sysop']['reupload'] = true;
5196 $wgGroupPermissions['sysop']['reupload-shared'] = true;
5197 $wgGroupPermissions['sysop']['unwatchedpages'] = true;
5198 $wgGroupPermissions['sysop']['autoconfirmed'] = true;
5199 $wgGroupPermissions['sysop']['editsemiprotected'] = true;
5200 $wgGroupPermissions['sysop']['ipblock-exempt'] = true;
5201 $wgGroupPermissions['sysop']['blockemail'] = true;
5202 $wgGroupPermissions['sysop']['markbotedits'] = true;
5203 $wgGroupPermissions['sysop']['apihighlimits'] = true;
5204 $wgGroupPermissions['sysop']['browsearchive'] = true;
5205 $wgGroupPermissions['sysop']['noratelimit'] = true;
5206 $wgGroupPermissions['sysop']['movefile'] = true;
5207 $wgGroupPermissions['sysop']['unblockself'] = true;
5208 $wgGroupPermissions['sysop']['suppressredirect'] = true;
5209 # $wgGroupPermissions['sysop']['pagelang'] = true;
5210 # $wgGroupPermissions['sysop']['upload_by_url'] = true;
5211 $wgGroupPermissions['sysop']['mergehistory'] = true;
5212 $wgGroupPermissions['sysop']['managechangetags'] = true;
5213 $wgGroupPermissions['sysop']['deletechangetags'] = true;
5215 $wgGroupPermissions['interface-admin']['editinterface'] = true;
5216 $wgGroupPermissions['interface-admin']['editsitecss'] = true;
5217 $wgGroupPermissions['interface-admin']['editsitejson'] = true;
5218 $wgGroupPermissions['interface-admin']['editsitejs'] = true;
5219 $wgGroupPermissions['interface-admin']['editusercss'] = true;
5220 $wgGroupPermissions['interface-admin']['edituserjson'] = true;
5221 $wgGroupPermissions['interface-admin']['edituserjs'] = true;
5223 // Permission to change users' group assignments
5224 $wgGroupPermissions['bureaucrat']['userrights'] = true;
5225 $wgGroupPermissions['bureaucrat']['noratelimit'] = true;
5226 // Permission to change users' groups assignments across wikis
5227 # $wgGroupPermissions['bureaucrat']['userrights-interwiki'] = true;
5228 // Permission to export pages including linked pages regardless of $wgExportMaxLinkDepth
5229 # $wgGroupPermissions['bureaucrat']['override-export-depth'] = true;
5231 # $wgGroupPermissions['sysop']['deletelogentry'] = true;
5232 # $wgGroupPermissions['sysop']['deleterevision'] = true;
5233 // To hide usernames from users and Sysops
5234 $wgGroupPermissions['suppress']['hideuser'] = true;
5235 // To hide revisions/log items from users and Sysops
5236 $wgGroupPermissions['suppress']['suppressrevision'] = true;
5237 // To view revisions/log items hidden from users and Sysops
5238 $wgGroupPermissions['suppress']['viewsuppressed'] = true;
5239 // For private suppression log access
5240 $wgGroupPermissions['suppress']['suppressionlog'] = true;
5241 // Basic rights for revision delete
5242 $wgGroupPermissions['suppress']['deleterevision'] = true;
5243 $wgGroupPermissions['suppress']['deletelogentry'] = true;
5246 * The developer group is deprecated, but can be activated if need be
5247 * to use the 'lockdb' and 'unlockdb' special pages. Those require
5248 * that a lock file be defined and creatable/removable by the web
5251 # $wgGroupPermissions['developer']['siteadmin'] = true;
5256 * Permission keys revoked from users in each group.
5258 * This acts the same way as wgGroupPermissions above, except that
5259 * if the user is in a group here, the permission will be removed from them.
5261 * Improperly setting this could mean that your users will be unable to perform
5262 * certain essential tasks, so use at your own risk!
5264 $wgRevokePermissions = [];
5267 * Implicit groups, aren't shown on Special:Listusers or somewhere else
5269 $wgImplicitGroups = [ '*', 'user', 'autoconfirmed' ];
5272 * A map of group names that the user is in, to group names that those users
5273 * are allowed to add or revoke.
5275 * Setting the list of groups to add or revoke to true is equivalent to "any
5279 * To allow sysops to add themselves to the "bot" group:
5281 * $wgGroupsAddToSelf = [ 'sysop' => [ 'bot' ] ];
5285 * Implicit groups may be used for the source group, for instance:
5287 * $wgGroupsRemoveFromSelf = [ '*' => true ];
5289 * This allows users in the '*' group (i.e. any user) to remove themselves from
5290 * any group that they happen to be in.
5292 $wgGroupsAddToSelf = [];
5295 * @see $wgGroupsAddToSelf
5297 $wgGroupsRemoveFromSelf = [];
5300 * Set of available actions that can be restricted via action=protect
5301 * You probably shouldn't change this.
5302 * Translated through restriction-* messages.
5303 * Title::getRestrictionTypes() will remove restrictions that are not
5304 * applicable to a specific title (create and upload)
5306 $wgRestrictionTypes = [ 'create', 'edit', 'move', 'upload' ];
5309 * Rights which can be required for each protection level (via action=protect)
5311 * You can add a new protection level that requires a specific
5312 * permission by manipulating this array. The ordering of elements
5313 * dictates the order on the protection form's lists.
5315 * - '' will be ignored (i.e. unprotected)
5316 * - 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility
5317 * - 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility
5319 $wgRestrictionLevels = [ '', 'autoconfirmed', 'sysop' ];
5322 * Restriction levels that can be used with cascading protection
5324 * A page can only be protected with cascading protection if the
5325 * requested restriction level is included in this array.
5327 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
5328 * 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility.
5330 $wgCascadingRestrictionLevels = [ 'sysop' ];
5333 * Restriction levels that should be considered "semiprotected"
5335 * Certain places in the interface recognize a dichotomy between "protected"
5336 * and "semiprotected", without further distinguishing the specific levels. In
5337 * general, if anyone can be eligible to edit a protection level merely by
5338 * reaching some condition in $wgAutopromote, it should probably be considered
5341 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
5342 * 'sysop' is not changed, since it really shouldn't be here.
5344 $wgSemiprotectedRestrictionLevels = [ 'autoconfirmed' ];
5347 * Set the minimum permissions required to edit pages in each
5348 * namespace. If you list more than one permission, a user must
5349 * have all of them to edit pages in that namespace.
5351 * @note NS_MEDIAWIKI is implicitly restricted to 'editinterface'.
5353 $wgNamespaceProtection = [];
5356 * Pages in namespaces in this array can not be used as templates.
5358 * Elements MUST be numeric namespace ids, you can safely use the MediaWiki
5359 * namespaces constants (NS_USER, NS_MAIN...).
5361 * Among other things, this may be useful to enforce read-restrictions
5362 * which may otherwise be bypassed by using the template mechanism.
5364 $wgNonincludableNamespaces = [];
5367 * Number of seconds an account is required to age before it's given the
5368 * implicit 'autoconfirm' group membership. This can be used to limit
5369 * privileges of new accounts.
5371 * Accounts created by earlier versions of the software may not have a
5372 * recorded creation date, and will always be considered to pass the age test.
5374 * When left at 0, all registered accounts will pass.
5377 * Set automatic confirmation to 10 minutes (which is 600 seconds):
5379 * $wgAutoConfirmAge = 600; // ten minutes
5381 * Set age to one day:
5383 * $wgAutoConfirmAge = 3600*24; // one day
5386 $wgAutoConfirmAge = 0;
5389 * Number of edits an account requires before it is autoconfirmed.
5390 * Passing both this AND the time requirement is needed. Example:
5394 * $wgAutoConfirmCount = 50;
5397 $wgAutoConfirmCount = 0;
5400 * Array containing the conditions of automatic promotion of a user to specific groups.
5402 * The basic syntax for `$wgAutopromote` is:
5404 * $wgAutopromote = [
5405 * 'groupname' => cond,
5406 * 'group2' => cond2,
5410 * - a single condition without arguments:
5411 * Note that Autopromote wraps a single non-array value into an array
5412 * e.g. `APCOND_EMAILCONFIRMED` OR
5413 * [ `APCOND_EMAILCONFIRMED` ]
5414 * - a single condition with arguments:
5415 * e.g. `[ APCOND_EDITCOUNT, 100 ]`
5416 * - a set of conditions:
5417 * e.g. `[ 'operand', cond1, cond2, ... ]`
5419 * When constructing a set of conditions, the following conditions are available:
5421 * promote if user matches **ALL** conditions
5423 * promote if user matches **ANY** condition
5425 * promote if user matches **ONLY ONE OF THE CONDITIONS**
5427 * promote if user matces **NO** condition
5428 * - [ APCOND_EMAILCONFIRMED ]:
5429 * true if user has a confirmed e-mail
5430 * - [ APCOND_EDITCOUNT, number of edits ]:
5431 * true if user has the at least the number of edits as the passed parameter
5432 * - [ APCOND_AGE, seconds since registration ]:
5433 * true if the length of time since the user created his/her account
5434 * is at least the same length of time as the passed parameter
5435 * - [ APCOND_AGE_FROM_EDIT, seconds since first edit ]:
5436 * true if the length of time since the user made his/her first edit
5437 * is at least the same length of time as the passed parameter
5438 * - [ APCOND_INGROUPS, group1, group2, ... ]:
5439 * true if the user is a member of each of the passed groups
5440 * - [ APCOND_ISIP, ip ]:
5441 * true if the user has the passed IP address
5442 * - [ APCOND_IPINRANGE, range ]:
5443 * true if the user has an IP address in the range of the passed parameter
5444 * - [ APCOND_BLOCKED ]:
5445 * true if the user is sitewide blocked
5446 * - [ APCOND_ISBOT ]:
5447 * true if the user is a bot
5448 * - similar constructs can be defined by extensions
5450 * The sets of conditions are evaluated recursively, so you can use nested sets of conditions
5451 * linked by operands.
5453 * Note that if $wgEmailAuthentication is disabled, APCOND_EMAILCONFIRMED will be true for any
5454 * user who has provided an e-mail address.
5457 'autoconfirmed' => [ '&',
5458 [ APCOND_EDITCOUNT
, &$wgAutoConfirmCount ],
5459 [ APCOND_AGE
, &$wgAutoConfirmAge ],
5464 * Automatically add a usergroup to any user who matches certain conditions.
5466 * Does not add the user to the group again if it has been removed.
5467 * Also, does not remove the group if the user no longer meets the criteria.
5471 * [ event => criteria, ... ]
5473 * Where event is either:
5474 * - 'onEdit' (when user edits)
5476 * Criteria has the same format as $wgAutopromote
5478 * @see $wgAutopromote
5481 $wgAutopromoteOnce = [
5486 * Put user rights log entries for autopromotion in recent changes?
5489 $wgAutopromoteOnceLogInRC = true;
5492 * $wgAddGroups and $wgRemoveGroups can be used to give finer control over who
5493 * can assign which groups at Special:Userrights.
5496 * Bureaucrats can add any group:
5498 * $wgAddGroups['bureaucrat'] = true;
5500 * Bureaucrats can only remove bots and sysops:
5502 * $wgRemoveGroups['bureaucrat'] = [ 'bot', 'sysop' ];
5504 * Sysops can make bots:
5506 * $wgAddGroups['sysop'] = [ 'bot' ];
5508 * Sysops can disable other sysops in an emergency, and disable bots:
5510 * $wgRemoveGroups['sysop'] = [ 'sysop', 'bot' ];
5518 $wgRemoveGroups = [];
5521 * A list of available rights, in addition to the ones defined by the core.
5522 * For extensions only.
5524 $wgAvailableRights = [];
5527 * Optional to restrict deletion of pages with higher revision counts
5528 * to users with the 'bigdelete' permission. (Default given to sysops.)
5530 $wgDeleteRevisionsLimit = 0;
5533 * Page deletions with > this number of revisions will use the job queue.
5534 * Revisions will be archived in batches of (at most) this size, one batch per job.
5536 $wgDeleteRevisionsBatchSize = 1000;
5539 * The maximum number of edits a user can have and
5540 * can still be hidden by users with the hideuser permission.
5541 * This is limited for performance reason.
5542 * Set to false to disable the limit.
5545 $wgHideUserContribLimit = 1000;
5548 * Number of accounts each IP address may create per specified period(s).
5552 * $wgAccountCreationThrottle = [
5553 * // no more than 100 per month
5556 * 'seconds' => 30*86400,
5558 * // no more than 10 per day
5561 * 'seconds' => 86400,
5566 * @warning Requires $wgMainCacheType to be enabled
5568 $wgAccountCreationThrottle = [ [
5574 * Edits matching these regular expressions in body text
5575 * will be recognised as spam and rejected automatically.
5577 * There's no administrator override on-wiki, so be careful what you set. :)
5578 * May be an array of regexes or a single string for backwards compatibility.
5580 * @see https://en.wikipedia.org/wiki/Regular_expression
5582 * @note Each regex needs a beginning/end delimiter, eg: # or /
5587 * Same as the above except for edit summaries
5589 $wgSummarySpamRegex = [];
5592 * Whether to use DNS blacklists in $wgDnsBlacklistUrls to check for open
5596 $wgEnableDnsBlacklist = false;
5599 * List of DNS blacklists to use, if $wgEnableDnsBlacklist is true.
5601 * This is an array of either a URL or an array with the URL and a key (should
5602 * the blacklist require a key).
5606 * $wgDnsBlacklistUrls = [
5607 * // String containing URL
5608 * 'http.dnsbl.sorbs.net.',
5609 * // Array with URL and key, for services that require a key
5610 * [ 'dnsbl.httpbl.net.', 'mykey' ],
5611 * // Array with just the URL. While this works, it is recommended that you
5612 * // just use a string as shown above
5613 * [ 'opm.tornevall.org.' ]
5617 * @note You should end the domain name with a . to avoid searching your
5618 * eventual domain search suffixes.
5621 $wgDnsBlacklistUrls = [ 'http.dnsbl.sorbs.net.' ];
5624 * Proxy whitelist, list of addresses that are assumed to be non-proxy despite
5625 * what the other methods might say.
5627 $wgProxyWhitelist = [];
5630 * IP ranges that should be considered soft-blocked (anon-only, account
5631 * creation allowed). The intent is to use this to prevent anonymous edits from
5632 * shared resources such as Wikimedia Labs.
5636 $wgSoftBlockRanges = [];
5639 * Whether to look at the X-Forwarded-For header's list of (potentially spoofed)
5640 * IPs and apply IP blocks to them. This allows for IP blocks to work with correctly-configured
5641 * (transparent) proxies without needing to block the proxies themselves.
5643 $wgApplyIpBlocksToXff = false;
5646 * Simple rate limiter options to brake edit floods.
5648 * Maximum number actions allowed in the given number of seconds; after that
5649 * the violating client receives HTTP 500 error pages until the period
5653 * Limits per configured per action and then type of users.
5657 * 'anon' => [ x, y ], // any and all anonymous edits (aggregate)
5658 * 'user' => [ x, y ], // each logged-in user
5659 * 'newbie' => [ x, y ], // each new autoconfirmed accounts; overrides 'user'
5660 * 'ip' => [ x, y ], // each anon and recent account
5661 * 'subnet' => [ x, y ], // ... within a /24 subnet in IPv4 or /64 in IPv6
5662 * 'groupName' => [ x, y ], // by group membership
5667 * @par Normally, the 'noratelimit' right allows a user to bypass any rate
5668 * limit checks. This can be disabled on a per-action basis by setting the
5669 * special '&can-bypass' key to false in that action's configuration.
5672 * 'some-action' => [
5673 * '&can-bypass' => false,
5674 * 'user' => [ x, y ],
5678 * @warning Requires that $wgMainCacheType is set to something persistent
5684 'newbie' => [ 8, 60 ],
5685 'user' => [ 90, 60 ],
5689 'newbie' => [ 2, 120 ],
5690 'user' => [ 8, 60 ],
5695 'newbie' => [ 8, 60 ],
5699 'user' => [ 10, 60 ],
5700 'newbie' => [ 5, 120 ]
5702 // Triggering password resets emails
5704 'ip' => [ 5, 3600 ],
5706 // Emailing other users using MediaWiki
5708 'ip' => [ 5, 86400 ],
5709 'newbie' => [ 5, 86400 ],
5710 'user' => [ 20, 86400 ],
5713 'ip-all' => [ 10, 3600 ],
5714 'user' => [ 4, 86400 ]
5716 // since 1.33 - rate limit email confirmations
5718 'ip-all' => [ 10, 3600 ],
5719 'user' => [ 4, 86400 ]
5724 'user' => [ 30, 60 ],
5726 // Purges of link tables
5729 'user' => [ 30, 60 ],
5731 // Files rendered via thumb.php or thumb_handler.php
5733 'ip' => [ 700, 30 ],
5734 'user' => [ 700, 30 ],
5736 // Same as above but for non-standard thumbnails
5737 'renderfile-nonstandard' => [
5739 'user' => [ 70, 30 ],
5741 // Stashing edits into cache before save
5744 'newbie' => [ 30, 60 ],
5746 // Adding or removing change tags
5749 'newbie' => [ 8, 60 ],
5751 // Changing the content model of a page
5752 'editcontentmodel' => [
5753 'newbie' => [ 2, 120 ],
5754 'user' => [ 8, 60 ],
5759 * Array of IPs / CIDR ranges which should be excluded from rate limits.
5760 * This may be useful for whitelisting NAT gateways for conferences, etc.
5762 $wgRateLimitsExcludedIPs = [];
5765 * Log IP addresses in the recentchanges table; can be accessed only by
5766 * extensions (e.g. CheckUser) or a DB admin
5767 * Used for retroactive autoblocks
5769 $wgPutIPinRC = true;
5772 * Integer defining default number of entries to show on
5773 * special pages which are query-pages such as Special:Whatlinkshere.
5775 $wgQueryPageDefaultLimit = 50;
5778 * Limit password attempts to X attempts per Y seconds per IP per account.
5780 * Value is an array of arrays. Each sub-array must have a key for count
5781 * (ie count of how many attempts before throttle) and a key for seconds.
5782 * If the key 'allIPs' (case sensitive) is present, then the limit is
5783 * just per account instead of per IP per account.
5785 * @since 1.27 allIps support and multiple limits added in 1.27. Prior
5786 * to 1.27 this only supported having a single throttle.
5787 * @warning Requires $wgMainCacheType to be enabled
5789 $wgPasswordAttemptThrottle = [
5791 [ 'count' => 5, 'seconds' => 300 ],
5792 // Long term limit. We need to balance the risk
5793 // of somebody using this as a DoS attack to lock someone
5794 // out of their account, and someone doing a brute force attack.
5795 [ 'count' => 150, 'seconds' => 60 * 60 * 48 ],
5799 * @var array Map of (grant => right => boolean)
5800 * Users authorize consumers (like Apps) to act on their behalf but only with
5801 * a subset of the user's normal account rights (signed off on by the user).
5802 * The possible rights to grant to a consumer are bundled into groups called
5803 * "grants". Each grant defines some rights it lets consumers inherit from the
5804 * account they may act on behalf of. Note that a user granting a right does
5805 * nothing if that user does not actually have that right to begin with.
5808 $wgGrantPermissions = [];
5810 // @TODO: clean up grants
5811 // @TODO: auto-include read/editsemiprotected rights?
5813 $wgGrantPermissions['basic']['autocreateaccount'] = true;
5814 $wgGrantPermissions['basic']['autoconfirmed'] = true;
5815 $wgGrantPermissions['basic']['autopatrol'] = true;
5816 $wgGrantPermissions['basic']['editsemiprotected'] = true;
5817 $wgGrantPermissions['basic']['ipblock-exempt'] = true;
5818 $wgGrantPermissions['basic']['nominornewtalk'] = true;
5819 $wgGrantPermissions['basic']['patrolmarks'] = true;
5820 $wgGrantPermissions['basic']['purge'] = true;
5821 $wgGrantPermissions['basic']['read'] = true;
5822 $wgGrantPermissions['basic']['skipcaptcha'] = true;
5823 $wgGrantPermissions['basic']['writeapi'] = true;
5825 $wgGrantPermissions['highvolume']['bot'] = true;
5826 $wgGrantPermissions['highvolume']['apihighlimits'] = true;
5827 $wgGrantPermissions['highvolume']['noratelimit'] = true;
5828 $wgGrantPermissions['highvolume']['markbotedits'] = true;
5830 $wgGrantPermissions['editpage']['edit'] = true;
5831 $wgGrantPermissions['editpage']['minoredit'] = true;
5832 $wgGrantPermissions['editpage']['applychangetags'] = true;
5833 $wgGrantPermissions['editpage']['changetags'] = true;
5835 $wgGrantPermissions['editprotected'] = $wgGrantPermissions['editpage'];
5836 $wgGrantPermissions['editprotected']['editprotected'] = true;
5838 // FIXME: Rename editmycssjs to editmyconfig
5839 $wgGrantPermissions['editmycssjs'] = $wgGrantPermissions['editpage'];
5840 $wgGrantPermissions['editmycssjs']['editmyusercss'] = true;
5841 $wgGrantPermissions['editmycssjs']['editmyuserjson'] = true;
5842 $wgGrantPermissions['editmycssjs']['editmyuserjs'] = true;
5844 $wgGrantPermissions['editmyoptions']['editmyoptions'] = true;
5845 $wgGrantPermissions['editmyoptions']['editmyuserjson'] = true;
5847 $wgGrantPermissions['editinterface'] = $wgGrantPermissions['editpage'];
5848 $wgGrantPermissions['editinterface']['editinterface'] = true;
5849 $wgGrantPermissions['editinterface']['edituserjson'] = true;
5850 $wgGrantPermissions['editinterface']['editsitejson'] = true;
5852 $wgGrantPermissions['editsiteconfig'] = $wgGrantPermissions['editinterface'];
5853 $wgGrantPermissions['editsiteconfig']['editusercss'] = true;
5854 $wgGrantPermissions['editsiteconfig']['edituserjs'] = true;
5855 $wgGrantPermissions['editsiteconfig']['editsitecss'] = true;
5856 $wgGrantPermissions['editsiteconfig']['editsitejs'] = true;
5858 $wgGrantPermissions['createeditmovepage'] = $wgGrantPermissions['editpage'];
5859 $wgGrantPermissions['createeditmovepage']['createpage'] = true;
5860 $wgGrantPermissions['createeditmovepage']['createtalk'] = true;
5861 $wgGrantPermissions['createeditmovepage']['move'] = true;
5862 $wgGrantPermissions['createeditmovepage']['move-rootuserpages'] = true;
5863 $wgGrantPermissions['createeditmovepage']['move-subpages'] = true;
5864 $wgGrantPermissions['createeditmovepage']['move-categorypages'] = true;
5865 $wgGrantPermissions['createeditmovepage']['suppressredirect'] = true;
5867 $wgGrantPermissions['uploadfile']['upload'] = true;
5868 $wgGrantPermissions['uploadfile']['reupload-own'] = true;
5870 $wgGrantPermissions['uploadeditmovefile'] = $wgGrantPermissions['uploadfile'];
5871 $wgGrantPermissions['uploadeditmovefile']['reupload'] = true;
5872 $wgGrantPermissions['uploadeditmovefile']['reupload-shared'] = true;
5873 $wgGrantPermissions['uploadeditmovefile']['upload_by_url'] = true;
5874 $wgGrantPermissions['uploadeditmovefile']['movefile'] = true;
5875 $wgGrantPermissions['uploadeditmovefile']['suppressredirect'] = true;
5877 $wgGrantPermissions['patrol']['patrol'] = true;
5879 $wgGrantPermissions['rollback']['rollback'] = true;
5881 $wgGrantPermissions['blockusers']['block'] = true;
5882 $wgGrantPermissions['blockusers']['blockemail'] = true;
5884 $wgGrantPermissions['viewdeleted']['browsearchive'] = true;
5885 $wgGrantPermissions['viewdeleted']['deletedhistory'] = true;
5886 $wgGrantPermissions['viewdeleted']['deletedtext'] = true;
5888 $wgGrantPermissions['viewrestrictedlogs']['suppressionlog'] = true;
5890 $wgGrantPermissions['delete'] = $wgGrantPermissions['editpage'] +
5891 $wgGrantPermissions['viewdeleted'];
5892 $wgGrantPermissions['delete']['delete'] = true;
5893 $wgGrantPermissions['delete']['bigdelete'] = true;
5894 $wgGrantPermissions['delete']['deletelogentry'] = true;
5895 $wgGrantPermissions['delete']['deleterevision'] = true;
5896 $wgGrantPermissions['delete']['undelete'] = true;
5898 $wgGrantPermissions['oversight']['suppressrevision'] = true;
5900 $wgGrantPermissions['protect'] = $wgGrantPermissions['editprotected'];
5901 $wgGrantPermissions['protect']['protect'] = true;
5903 $wgGrantPermissions['viewmywatchlist']['viewmywatchlist'] = true;
5905 $wgGrantPermissions['editmywatchlist']['editmywatchlist'] = true;
5907 $wgGrantPermissions['sendemail']['sendemail'] = true;
5909 $wgGrantPermissions['createaccount']['createaccount'] = true;
5911 $wgGrantPermissions['privateinfo']['viewmyprivateinfo'] = true;
5914 * @var array Map of grants to their UI grouping
5917 $wgGrantPermissionGroups = [
5918 // Hidden grants are implicitly present
5919 'basic' => 'hidden',
5921 'editpage' => 'page-interaction',
5922 'createeditmovepage' => 'page-interaction',
5923 'editprotected' => 'page-interaction',
5924 'patrol' => 'page-interaction',
5926 'uploadfile' => 'file-interaction',
5927 'uploadeditmovefile' => 'file-interaction',
5929 'sendemail' => 'email',
5931 'viewmywatchlist' => 'watchlist-interaction',
5932 'editviewmywatchlist' => 'watchlist-interaction',
5934 'editmycssjs' => 'customization',
5935 'editmyoptions' => 'customization',
5937 'editinterface' => 'administration',
5938 'editsiteconfig' => 'administration',
5939 'rollback' => 'administration',
5940 'blockusers' => 'administration',
5941 'delete' => 'administration',
5942 'viewdeleted' => 'administration',
5943 'viewrestrictedlogs' => 'administration',
5944 'protect' => 'administration',
5945 'oversight' => 'administration',
5946 'createaccount' => 'administration',
5948 'highvolume' => 'high-volume',
5950 'privateinfo' => 'private-information',
5954 * @var bool Whether to enable bot passwords
5957 $wgEnableBotPasswords = true;
5960 * Cluster for the bot_passwords table
5961 * @var string|bool If false, the normal cluster will be used
5964 $wgBotPasswordsCluster = false;
5967 * Database name for the bot_passwords table
5969 * To use a database with a table prefix, set this variable to
5970 * "{$database}-{$prefix}".
5971 * @var string|bool If false, the normal database will be used
5974 $wgBotPasswordsDatabase = false;
5976 /** @} */ # end of user rights settings
5978 /************************************************************************//**
5979 * @name Proxy scanner settings
5984 * This should always be customised in LocalSettings.php
5986 $wgSecretKey = false;
5989 * Big list of banned IP addresses.
5991 * This can have the following formats:
5992 * - An array of addresses
5993 * - A string, in which case this is the path to a file
5994 * containing the list of IP addresses, one per line
5998 /** @} */ # end of proxy scanner settings
6000 /************************************************************************//**
6001 * @name Cookie settings
6006 * Default cookie lifetime, in seconds. Setting to 0 makes all cookies session-only.
6008 $wgCookieExpiration = 30 * 86400;
6011 * Default login cookie lifetime, in seconds. Setting
6012 * $wgExtendLoginCookieExpiration to null will use $wgCookieExpiration to
6013 * calculate the cookie lifetime. As with $wgCookieExpiration, 0 will make
6014 * login cookies session-only.
6016 $wgExtendedLoginCookieExpiration = 180 * 86400;
6019 * Set to set an explicit domain on the login cookies eg, "justthis.domain.org"
6020 * or ".any.subdomain.net"
6022 $wgCookieDomain = '';
6025 * Set this variable if you want to restrict cookies to a certain path within
6026 * the domain specified by $wgCookieDomain.
6028 $wgCookiePath = '/';
6031 * Whether the "secure" flag should be set on the cookie. This can be:
6032 * - true: Set secure flag
6033 * - false: Don't set secure flag
6034 * - "detect": Set the secure flag if $wgServer is set to an HTTPS URL
6036 $wgCookieSecure = 'detect';
6039 * By default, MediaWiki checks if the client supports cookies during the
6040 * login process, so that it can display an informative error message if
6041 * cookies are disabled. Set this to true if you want to disable this cookie
6044 $wgDisableCookieCheck = false;
6047 * Cookies generated by MediaWiki have names starting with this prefix. Set it
6048 * to a string to use a custom prefix. Setting it to false causes the database
6049 * name to be used as a prefix.
6051 $wgCookiePrefix = false;
6054 * Set authentication cookies to HttpOnly to prevent access by JavaScript,
6055 * in browsers that support this feature. This can mitigates some classes of
6058 $wgCookieHttpOnly = true;
6061 * A list of cookies that vary the cache (for use by extensions)
6063 $wgCacheVaryCookies = [];
6066 * Override to customise the session name
6068 $wgSessionName = false;
6071 * Whether to set a cookie when a user is autoblocked. Doing so means that a blocked user, even
6072 * after logging out and moving to a new IP address, will still be blocked. This cookie will contain
6073 * an authentication code if $wgSecretKey is set, or otherwise will just be the block ID (in
6074 * which case there is a possibility of an attacker discovering the names of revdeleted users, so
6075 * it is best to use this in conjunction with $wgSecretKey being set).
6077 $wgCookieSetOnAutoblock = false;
6080 * Whether to set a cookie when a logged-out user is blocked. Doing so means that a blocked user,
6081 * even after moving to a new IP address, will still be blocked. This cookie will contain an
6082 * authentication code if $wgSecretKey is set, or otherwise will just be the block ID (in which
6083 * case there is a possibility of an attacker discovering the names of revdeleted users, so it
6084 * is best to use this in conjunction with $wgSecretKey being set).
6086 $wgCookieSetOnIpBlock = false;
6088 /** @} */ # end of cookie settings }
6090 /************************************************************************//**
6091 * @name LaTeX (mathematical formulas)
6096 * To use inline TeX, you need to compile 'texvc' (in the 'math' subdirectory of
6097 * the MediaWiki package and have latex, dvips, gs (ghostscript), andconvert
6098 * (ImageMagick) installed and available in the PATH.
6099 * Please see math/README for more information.
6103 /** @} */ # end LaTeX }
6105 /************************************************************************//**
6106 * @name Profiling, testing and debugging
6108 * See $wgProfiler for how to enable profiling.
6114 * Filename for debug logging. See https://www.mediawiki.org/wiki/How_to_debug
6115 * The debug log file should be not be publicly accessible if it is used, as it
6116 * may contain private data.
6118 $wgDebugLogFile = '';
6121 * Prefix for debug log lines
6123 $wgDebugLogPrefix = '';
6126 * If true, instead of redirecting, show a page with a link to the redirect
6127 * destination. This allows for the inspection of PHP error messages, and easy
6128 * resubmission of form data. For developer use only.
6130 $wgDebugRedirects = false;
6133 * If true, log debugging data from action=raw and load.php.
6134 * This is normally false to avoid overlapping debug entries due to gen=css
6135 * and gen=js requests.
6137 $wgDebugRawPage = false;
6140 * Send debug data to an HTML comment in the output.
6142 * This may occasionally be useful when supporting a non-technical end-user.
6143 * It's more secure than exposing the debug log file to the web, since the
6144 * output only contains private data for the current user. But it's not ideal
6145 * for development use since data is lost on fatal errors and redirects.
6147 $wgDebugComments = false;
6150 * Write SQL queries to the debug log.
6152 * This setting is only used $wgLBFactoryConf['class'] is set to
6153 * '\Wikimedia\Rdbms\LBFactorySimple' and $wgDBservers is an empty array; otherwise
6154 * the DBO_DEBUG flag must be set in the 'flags' option of the database
6155 * connection to achieve the same functionality.
6157 $wgDebugDumpSql = false;
6160 * Performance expectations for DB usage
6164 $wgTrxProfilerLimits = [
6165 // HTTP GET/HEAD requests.
6166 // Master queries should not happen on GET requests
6170 'readQueryTime' => 5,
6171 'readQueryRows' => 10000
6173 // HTTP POST requests.
6174 // Master reads and writes will happen for a subset of these.
6176 'readQueryTime' => 5,
6177 'writeQueryTime' => 1,
6178 'readQueryRows' => 100000,
6179 'maxAffected' => 1000
6181 'POST-nonwrite' => [
6183 'readQueryTime' => 5,
6184 'readQueryRows' => 10000
6186 // Deferred updates that run after HTTP response is sent for GET requests
6188 'readQueryTime' => 5,
6189 'writeQueryTime' => 1,
6190 'readQueryRows' => 10000,
6191 'maxAffected' => 1000,
6192 // Log master queries under the post-send entry point as they are discouraged
6196 // Deferred updates that run after HTTP response is sent for POST requests
6197 'PostSend-POST' => [
6198 'readQueryTime' => 5,
6199 'writeQueryTime' => 1,
6200 'readQueryRows' => 100000,
6201 'maxAffected' => 1000
6203 // Background job runner
6205 'readQueryTime' => 30,
6206 'writeQueryTime' => 5,
6207 'readQueryRows' => 100000,
6208 'maxAffected' => 500 // ballpark of $wgUpdateRowsPerQuery
6210 // Command-line scripts
6212 'writeQueryTime' => 5,
6213 'maxAffected' => 1000
6218 * Map of string log group names to log destinations.
6220 * If set, wfDebugLog() output for that group will go to that file instead
6221 * of the regular $wgDebugLogFile. Useful for enabling selective logging
6224 * Log destinations may be one of the following:
6225 * - false to completely remove from the output, including from $wgDebugLogFile.
6226 * - string values specifying a filename or URI.
6227 * - associative array with keys:
6228 * - 'destination' desired filename or URI.
6229 * - 'sample' an integer value, specifying a sampling factor (optional)
6230 * - 'level' A \Psr\Log\LogLevel constant, indicating the minimum level
6231 * to log (optional, since 1.25)
6235 * $wgDebugLogGroups['redis'] = '/var/log/mediawiki/redis.log';
6238 * @par Advanced example:
6240 * $wgDebugLogGroups['memcached'] = [
6241 * 'destination' => '/var/log/mediawiki/memcached.log',
6242 * 'sample' => 1000, // log 1 message out of every 1,000.
6243 * 'level' => \Psr\Log\LogLevel::WARNING
6247 $wgDebugLogGroups = [];
6250 * Default service provider for creating Psr\Log\LoggerInterface instances.
6252 * The value should be an array suitable for use with
6253 * ObjectFactory::getObjectFromSpec(). The created object is expected to
6254 * implement the MediaWiki\Logger\Spi interface. See ObjectFactory for additional
6257 * Alternately the MediaWiki\Logger\LoggerFactory::registerProvider method can
6258 * be called to inject an MediaWiki\Logger\Spi instance into the LoggerFactory
6259 * and bypass the use of this configuration variable entirely.
6261 * @par To completely disable logging:
6263 * $wgMWLoggerDefaultSpi = [ 'class' => \MediaWiki\Logger\NullSpi::class ];
6267 * @var array $wgMWLoggerDefaultSpi
6270 $wgMWLoggerDefaultSpi = [
6271 'class' => \MediaWiki\Logger\LegacySpi
::class,
6275 * Display debug data at the bottom of the main content area.
6277 * Useful for developers and technical users trying to working on a closed wiki.
6279 $wgShowDebug = false;
6282 * Prefix debug messages with relative timestamp. Very-poor man's profiler.
6283 * Since 1.19 also includes memory usage.
6285 $wgDebugTimestamps = false;
6288 * Show the contents of $wgHooks in Special:Version
6290 $wgSpecialVersionShowHooks = false;
6293 * Whether to show "we're sorry, but there has been a database error" pages.
6294 * Displaying errors aids in debugging, but may display information useful
6297 * @deprecated and nonfunctional since 1.32: set $wgShowExceptionDetails and/or
6298 * $wgShowHostnames instead.
6300 $wgShowSQLErrors = false;
6303 * If set to true, uncaught exceptions will print the exception message and a
6304 * complete stack trace to output. This should only be used for debugging, as it
6305 * may reveal private information in function parameters due to PHP's backtrace
6306 * formatting. If set to false, only the exception's class will be shown.
6308 $wgShowExceptionDetails = false;
6311 * If true, show a backtrace for database errors
6313 * @note This setting only applies when connection errors and query errors are
6314 * reported in the normal manner. $wgShowExceptionDetails applies in other cases,
6315 * including those in which an uncaught exception is thrown from within the
6316 * exception handler.
6318 * @deprecated and nonfunctional since 1.32: set $wgShowExceptionDetails instead.
6320 $wgShowDBErrorBacktrace = false;
6323 * If true, send the exception backtrace to the error log
6325 $wgLogExceptionBacktrace = true;
6328 * If true, the MediaWiki error handler passes errors/warnings to the default error handler
6329 * after logging them. The setting is ignored when the track_errors php.ini flag is true.
6331 $wgPropagateErrors = true;
6334 * Expose backend server host names through the API and various HTML comments
6336 $wgShowHostnames = false;
6339 * Override server hostname detection with a hardcoded value.
6340 * Should be a string, default false.
6343 $wgOverrideHostname = false;
6346 * If set to true MediaWiki will throw notices for some possible error
6347 * conditions and for deprecated functions.
6349 $wgDevelopmentWarnings = false;
6352 * Release limitation to wfDeprecated warnings, if set to a release number
6353 * development warnings will not be generated for deprecations added in releases
6356 $wgDeprecationReleaseLimit = false;
6359 * Profiler configuration.
6361 * To use a profiler, set $wgProfiler in LocalSetings.php.
6366 * $wgProfiler['class'] = ProfilerXhprof::class;
6369 * For output, set the 'output' key to an array of class names, one for each
6370 * output type you want the profiler to generate. For example:
6373 * $wgProfiler['output'] = [ ProfilerOutputText::class ];
6376 * The output classes available to you by default are ProfilerOutputDb,
6377 * ProfilerOutputDump, ProfilerOutputStats, ProfilerOutputText, and
6378 * ProfilerOutputUdp.
6380 * ProfilerOutputStats outputs profiling data as StatsD metrics. It expects
6381 * that you have set the $wgStatsdServer configuration variable to the host (or
6382 * host:port) of your statsd server.
6384 * ProfilerOutputText will output profiling data in the page body as a comment.
6385 * You can make the profiling data in HTML render as part of the page content
6386 * by setting the 'visible' configuration flag:
6389 * $wgProfiler['visible'] = true;
6392 * 'ProfilerOutputDb' expects a database table that can be created by applying
6393 * maintenance/archives/patch-profiling.sql to your database.
6395 * 'ProfilerOutputDump' expects a $wgProfiler['outputDir'] telling it where to
6396 * write dump files. The files produced are compatible with the XHProf gui.
6397 * For a rudimentary sampling profiler:
6400 * $wgProfiler['class'] = 'ProfilerXhprof';
6401 * $wgProfiler['output'] = [ 'ProfilerOutputDb' ];
6402 * $wgProfiler['sampling'] = 50; // one every 50 requests
6405 * When using the built-in `sampling` option, the `class` will changed to
6406 * ProfilerStub for non-sampled cases.
6408 * For performance, the profiler is always disabled for CLI scripts as they
6409 * could be long running and the data would accumulate. Use the '--profiler'
6410 * parameter of maintenance scripts to override this.
6417 * Allow the profileinfo.php entrypoint to be used.
6421 $wgEnableProfileInfo = false;
6424 * Only record profiling info for pages that took longer than this
6425 * @deprecated since 1.25: set $wgProfiler['threshold'] instead.
6427 $wgProfileLimit = 0.0;
6430 * Don't put non-profiling info into log file
6432 * @deprecated since 1.23, set the log file in
6433 * $wgDebugLogGroups['profileoutput'] instead.
6435 $wgProfileOnly = false;
6438 * Destination of statsd metrics.
6440 * A host or host:port of a statsd server. Port defaults to 8125.
6442 * If not set, statsd metrics will not be collected.
6444 * @see wfLogProfilingData
6447 $wgStatsdServer = false;
6450 * Prefix for metric names sent to $wgStatsdServer.
6452 * @see MediaWikiServices::getInstance()->getStatsdDataFactory
6453 * @see BufferingStatsdDataFactory
6456 $wgStatsdMetricPrefix = 'MediaWiki';
6459 * Sampling rate for statsd metrics as an associative array of patterns and rates.
6460 * Patterns are Unix shell patterns (e.g. 'MediaWiki.api.*').
6461 * Rates are sampling probabilities (e.g. 0.1 means 1 in 10 events are sampled).
6464 $wgStatsdSamplingRates = [
6465 'wanobjectcache:*' => 0.001
6469 * InfoAction retrieves a list of transclusion links (both to and from).
6470 * This number puts a limit on that query in the case of highly transcluded
6473 $wgPageInfoTransclusionLimit = 50;
6476 * Parser test suite files to be run by parserTests.php when no specific
6477 * filename is passed to it.
6479 * Extensions using extension.json will have any *.txt file in a
6480 * tests/parser/ directory automatically run.
6482 * Core tests can be added to ParserTestRunner::$coreTestFiles.
6486 * @deprecated since 1.30
6488 $wgParserTestFiles = [];
6491 * Allow running of javascript test suites via [[Special:JavaScriptTest]] (such as QUnit).
6493 $wgEnableJavaScriptTest = false;
6496 * Overwrite the caching key prefix with custom value.
6499 $wgCachePrefix = false;
6502 * Display the new debugging toolbar. This also enables profiling on database
6503 * queries and other useful output.
6504 * Will be ignored if $wgUseFileCache or $wgUseCdn is enabled.
6508 $wgDebugToolbar = false;
6510 /** @} */ # end of profiling, testing and debugging }
6512 /************************************************************************//**
6518 * Set this to true to disable the full text search feature.
6520 $wgDisableTextSearch = false;
6523 * Set to true to have nicer highlighted text in search results,
6524 * by default off due to execution overhead
6526 $wgAdvancedSearchHighlighting = false;
6529 * Regexp to match word boundaries, defaults for non-CJK languages
6530 * should be empty for CJK since the words are not separate
6532 $wgSearchHighlightBoundaries = '[\p{Z}\p{P}\p{C}]';
6535 * Template for OpenSearch suggestions, defaults to API action=opensearch
6537 * Sites with heavy load would typically have these point to a custom
6538 * PHP wrapper to avoid firing up mediawiki for every keystroke
6540 * Placeholders: {searchTerms}
6542 * @deprecated since 1.25 Use $wgOpenSearchTemplates['application/x-suggestions+json'] instead
6544 $wgOpenSearchTemplate = false;
6547 * Templates for OpenSearch suggestions, defaults to API action=opensearch
6549 * Sites with heavy load would typically have these point to a custom
6550 * PHP wrapper to avoid firing up mediawiki for every keystroke
6552 * Placeholders: {searchTerms}
6554 $wgOpenSearchTemplates = [
6555 'application/x-suggestions+json' => false,
6556 'application/x-suggestions+xml' => false,
6560 * Enable OpenSearch suggestions requested by MediaWiki. Set this to
6561 * false if you've disabled scripts that use api?action=opensearch and
6562 * want reduce load caused by cached scripts still pulling suggestions.
6563 * It will let the API fallback by responding with an empty array.
6565 $wgEnableOpenSearchSuggest = true;
6568 * Integer defining default number of entries to show on
6571 $wgOpenSearchDefaultLimit = 10;
6574 * Minimum length of extract in <Description>. Actual extracts will last until the end of sentence.
6576 $wgOpenSearchDescriptionLength = 100;
6579 * Expiry time for search suggestion responses
6581 $wgSearchSuggestCacheExpiry = 1200;
6584 * If you've disabled search semi-permanently, this also disables updates to the
6585 * table. If you ever re-enable, be sure to rebuild the search table.
6587 $wgDisableSearchUpdate = false;
6590 * List of namespaces which are searched by default.
6594 * $wgNamespacesToBeSearchedDefault[NS_MAIN] = true;
6595 * $wgNamespacesToBeSearchedDefault[NS_PROJECT] = true;
6598 $wgNamespacesToBeSearchedDefault = [
6603 * Disable the internal MySQL-based search, to allow it to be
6604 * implemented by an extension instead.
6606 $wgDisableInternalSearch = false;
6609 * Set this to a URL to forward search requests to some external location.
6610 * If the URL includes '$1', this will be replaced with the URL-encoded
6614 * To forward to Google you'd have something like:
6616 * $wgSearchForwardUrl =
6617 * 'https://www.google.com/search?q=$1' .
6618 * '&domains=https://example.com' .
6619 * '&sitesearch=https://example.com' .
6620 * '&ie=utf-8&oe=utf-8';
6623 $wgSearchForwardUrl = null;
6626 * Search form behavior.
6627 * - true = use Go & Search buttons
6628 * - false = use Go button & Advanced search link
6630 $wgUseTwoButtonsSearchForm = true;
6633 * Array of namespaces to generate a Google sitemap for when the
6634 * maintenance/generateSitemap.php script is run, or false if one is to be
6635 * generated for all namespaces.
6637 $wgSitemapNamespaces = false;
6640 * Custom namespace priorities for sitemaps. Setting this will allow you to
6641 * set custom priorities to namespaces when sitemaps are generated using the
6642 * maintenance/generateSitemap.php script.
6644 * This should be a map of namespace IDs to priority
6647 * $wgSitemapNamespacesPriorities = [
6653 $wgSitemapNamespacesPriorities = false;
6656 * If true, searches for IP addresses will be redirected to that IP's
6657 * contributions page. E.g. searching for "1.2.3.4" will redirect to
6658 * [[Special:Contributions/1.2.3.4]]
6660 $wgEnableSearchContributorsByIP = true;
6662 /** @} */ # end of search settings
6664 /************************************************************************//**
6665 * @name Edit user interface
6670 * Path to the GNU diff3 utility. If the file doesn't exist, edit conflicts will
6671 * fall back to the old behavior (no merging).
6673 $wgDiff3 = '/usr/bin/diff3';
6676 * Path to the GNU diff utility.
6678 $wgDiff = '/usr/bin/diff';
6681 * Which namespaces have special treatment where they should be preview-on-open
6682 * Internally only Category: pages apply, but using this extensions (e.g. Semantic MediaWiki)
6683 * can specify namespaces of pages they have special treatment for
6685 $wgPreviewOnOpenNamespaces = [
6690 * Enable the UniversalEditButton for browsers that support it
6691 * (currently only Firefox with an extension)
6692 * See http://universaleditbutton.org for more background information
6694 $wgUniversalEditButton = true;
6697 * If user doesn't specify any edit summary when making a an edit, MediaWiki
6698 * will try to automatically create one. This feature can be disabled by set-
6699 * ting this variable false.
6701 $wgUseAutomaticEditSummaries = true;
6703 /** @} */ # end edit UI }
6705 /************************************************************************//**
6707 * See also $wgSiteNotice
6712 * @cond file_level_code
6713 * Set $wgCommandLineMode if it's not set already, to avoid notices
6715 if ( !isset( $wgCommandLineMode ) ) {
6716 $wgCommandLineMode = false;
6721 * For colorized maintenance script output, is your terminal background dark ?
6723 $wgCommandLineDarkBg = false;
6726 * Set this to a string to put the wiki into read-only mode. The text will be
6727 * used as an explanation to users.
6729 * This prevents most write operations via the web interface. Cache updates may
6730 * still be possible. To prevent database writes completely, use the read_only
6736 * Set this to true to put the wiki watchlists into read-only mode.
6740 $wgReadOnlyWatchedItemStore = false;
6743 * If this lock file exists (size > 0), the wiki will be forced into read-only mode.
6744 * Its contents will be shown to users as part of the read-only warning
6747 * Will default to "{$wgUploadDirectory}/lock_yBgMBwiR" in Setup.php
6749 $wgReadOnlyFile = false;
6752 * When you run the web-based upgrade utility, it will tell you what to set
6753 * this to in order to authorize the upgrade process. It will subsequently be
6754 * used as a password, to authorize further upgrades.
6756 * For security, do not set this to a guessable string. Use the value supplied
6757 * by the install/upgrade process. To cause the upgrader to generate a new key,
6758 * delete the old key from LocalSettings.php.
6760 $wgUpgradeKey = false;
6763 * Fully specified path to git binary
6765 $wgGitBin = '/usr/bin/git';
6768 * Map GIT repository URLs to viewer URLs to provide links in Special:Version
6770 * Key is a pattern passed to preg_match() and preg_replace(),
6771 * without the delimiters (which are #) and must match the whole URL.
6772 * The value is the replacement for the key (it can contain $1, etc.)
6773 * %h will be replaced by the short SHA-1 (7 first chars) and %H by the
6774 * full SHA-1 of the HEAD revision.
6775 * %r will be replaced with a URL-encoded version of $1.
6776 * %R will be replaced with $1 and no URL-encoding
6780 $wgGitRepositoryViewers = [
6781 'https://(?:[a-z0-9_]+@)?gerrit.wikimedia.org/r/(?:p/)?(.*)' =>
6782 'https://gerrit.wikimedia.org/g/%R/+/%H',
6783 'ssh://(?:[a-z0-9_]+@)?gerrit.wikimedia.org:29418/(.*)' =>
6784 'https://gerrit.wikimedia.org/g/%R/+/%H',
6787 /** @} */ # End of maintenance }
6789 /************************************************************************//**
6790 * @name Recent changes, new pages, watchlist and history
6795 * Recentchanges items are periodically purged; entries older than this many
6797 * Default: 90 days = about three months
6799 $wgRCMaxAge = 90 * 24 * 3600;
6802 * Page watchers inactive for more than this many seconds are considered inactive.
6803 * Used mainly by action=info. Default: 180 days = about six months.
6806 $wgWatchersMaxAge = 180 * 24 * 3600;
6809 * If active watchers (per above) are this number or less, do not disclose it.
6810 * Left to 1, prevents unprivileged users from knowing for sure that there are 0.
6811 * Set to -1 if you want to always complement watchers count with this info.
6814 $wgUnwatchedPageSecret = 1;
6817 * Filter $wgRCLinkDays by $wgRCMaxAge to avoid showing links for numbers
6818 * higher than what will be stored. Note that this is disabled by default
6819 * because we sometimes do have RC data which is beyond the limit for some
6820 * reason, and some users may use the high numbers to display that data which
6823 $wgRCFilterByAge = false;
6826 * List of Limits options to list in the Special:Recentchanges and
6827 * Special:Recentchangeslinked pages.
6829 $wgRCLinkLimits = [ 50, 100, 250, 500 ];
6832 * List of Days options to list in the Special:Recentchanges and
6833 * Special:Recentchangeslinked pages.
6835 * @see ChangesListSpecialPage::getLinkDays
6837 $wgRCLinkDays = [ 1, 3, 7, 14, 30 ];
6840 * Configuration for feeds to which notifications about recent changes will be sent.
6842 * The following feed classes are available by default:
6843 * - 'UDPRCFeedEngine' - sends recent changes over UDP to the specified server.
6844 * - 'RedisPubSubFeedEngine' - send recent changes to Redis.
6846 * Only 'class' or 'uri' is required. If 'uri' is set instead of 'class', then
6847 * RecentChange::getEngine() is used to determine the class. All options are
6848 * passed to the constructor.
6851 * - 'class' -- The class to use for this feed (must implement RCFeed).
6852 * - 'omit_bots' -- Exclude bot edits from the feed. (default: false)
6853 * - 'omit_anon' -- Exclude anonymous edits from the feed. (default: false)
6854 * - 'omit_user' -- Exclude edits by registered users from the feed. (default: false)
6855 * - 'omit_minor' -- Exclude minor edits from the feed. (default: false)
6856 * - 'omit_patrolled' -- Exclude patrolled edits from the feed. (default: false)
6858 * FormattedRCFeed-specific options:
6859 * - 'uri' -- [required] The address to which the messages are sent.
6860 * The uri scheme of this string will be looked up in $wgRCEngines
6861 * to determine which FormattedRCFeed class to use.
6862 * - 'formatter' -- [required] The class (implementing RCFeedFormatter) which will
6863 * produce the text to send. This can also be an object of the class.
6864 * Formatters available by default: JSONRCFeedFormatter, XMLRCFeedFormatter,
6865 * IRCColourfulRCFeedFormatter.
6867 * IRCColourfulRCFeedFormatter-specific options:
6868 * - 'add_interwiki_prefix' -- whether the titles should be prefixed with
6869 * the first entry in the $wgLocalInterwikis array (or the value of
6870 * $wgLocalInterwiki, if set)
6872 * JSONRCFeedFormatter-specific options:
6873 * - 'channel' -- if set, the 'channel' parameter is also set in JSON values.
6875 * @example $wgRCFeeds['example'] = [
6876 * 'uri' => 'udp://localhost:1336',
6877 * 'formatter' => 'JSONRCFeedFormatter',
6878 * 'add_interwiki_prefix' => false,
6879 * 'omit_bots' => true,
6881 * @example $wgRCFeeds['example'] = [
6882 * 'uri' => 'udp://localhost:1338',
6883 * 'formatter' => 'IRCColourfulRCFeedFormatter',
6884 * 'add_interwiki_prefix' => false,
6885 * 'omit_bots' => true,
6887 * @example $wgRCFeeds['example'] = [
6888 * 'class' => ExampleRCFeed::class,
6895 * Used by RecentChange::getEngine to find the correct engine for a given URI scheme.
6896 * Keys are scheme names, values are names of FormattedRCFeed sub classes.
6900 'redis' => RedisPubSubFeedEngine
::class,
6901 'udp' => UDPRCFeedEngine
::class,
6905 * Treat category membership changes as a RecentChange.
6906 * Changes are mentioned in RC for page actions as follows:
6907 * - creation: pages created with categories are mentioned
6908 * - edit: category additions/removals to existing pages are mentioned
6909 * - move: nothing is mentioned (unless templates used depend on the title)
6910 * - deletion: nothing is mentioned
6911 * - undeletion: nothing is mentioned
6915 $wgRCWatchCategoryMembership = false;
6918 * Use RC Patrolling to check for vandalism (from recent changes and watchlists)
6919 * New pages and new files are included.
6921 * @note If you disable all patrolling features, you probably also want to
6922 * remove 'patrol' from $wgFilterLogTypes so a show/hide link isn't shown on
6925 $wgUseRCPatrol = true;
6928 * Polling rate, in seconds, used by the 'live update' and 'view newest' features
6929 * of the RCFilters app on SpecialRecentChanges and Special:Watchlist.
6930 * 0 to disable completely.
6932 $wgStructuredChangeFiltersLiveUpdatePollingRate = 3;
6935 * Use new page patrolling to check new pages on Special:Newpages
6937 * @note If you disable all patrolling features, you probably also want to
6938 * remove 'patrol' from $wgFilterLogTypes so a show/hide link isn't shown on
6941 $wgUseNPPatrol = true;
6944 * Use file patrolling to check new files on Special:Newfiles
6946 * @note If you disable all patrolling features, you probably also want to
6947 * remove 'patrol' from $wgFilterLogTypes so a show/hide link isn't shown on
6952 $wgUseFilePatrol = true;
6955 * Provide syndication feeds (RSS, Atom) for, e.g., Recentchanges, Newpages
6960 * Set maximum number of results to return in syndication feeds (RSS, Atom) for
6961 * eg Recentchanges, Newpages.
6966 * _Minimum_ timeout for cached Recentchanges feed, in seconds.
6967 * A cached version will continue to be served out even if changes
6968 * are made, until this many seconds runs out since the last render.
6970 * If set to 0, feed caching is disabled. Use this for debugging only;
6971 * feed generation can be pretty slow with diffs.
6973 $wgFeedCacheTimeout = 60;
6976 * When generating Recentchanges RSS/Atom feed, diffs will not be generated for
6977 * pages larger than this size.
6979 $wgFeedDiffCutoff = 32768;
6982 * Override the site's default RSS/ATOM feed for recentchanges that appears on
6983 * every page. Some sites might have a different feed they'd like to promote
6984 * instead of the RC feed (maybe like a "Recent New Articles" or "Breaking news" one).
6985 * Should be a format as key (either 'rss' or 'atom') and an URL to the feed
6988 * Configure the 'atom' feed to https://example.com/somefeed.xml
6990 * $wgSiteFeed['atom'] = "https://example.com/somefeed.xml";
6993 $wgOverrideSiteFeed = [];
6996 * Available feeds objects.
6997 * Should probably only be defined when a page is syndicated ie when
6998 * $wgOut->isSyndicated() is true.
7001 'rss' => RSSFeed
::class,
7002 'atom' => AtomFeed
::class,
7006 * Which feed types should we provide by default? This can include 'rss',
7007 * 'atom', neither, or both.
7009 $wgAdvertisedFeedTypes = [ 'atom' ];
7012 * Show watching users in recent changes, watchlist and page history views
7014 $wgRCShowWatchingUsers = false; # UPO
7017 * Show the amount of changed characters in recent changes
7019 $wgRCShowChangedSize = true;
7022 * If the difference between the character counts of the text
7023 * before and after the edit is below that value, the value will be
7024 * highlighted on the RC page.
7026 $wgRCChangedSizeThreshold = 500;
7029 * Show "Updated (since my last visit)" marker in RC view, watchlist and history
7030 * view for watched pages with new changes
7032 $wgShowUpdatedMarker = true;
7035 * Disable links to talk pages of anonymous users (IPs) in listings on special
7036 * pages like page history, Special:Recentchanges, etc.
7038 $wgDisableAnonTalk = false;
7041 * Allow filtering by change tag in recentchanges, history, etc
7042 * Has no effect if no tags are defined in valid_tag.
7044 $wgUseTagFilter = true;
7047 * List of core tags to enable. Available tags are:
7048 * - 'mw-contentmodelchange': Edit changes content model of a page
7049 * - 'mw-new-redirect': Edit makes new redirect page (new page or by changing content page)
7050 * - 'mw-removed-redirect': Edit changes an existing redirect into a non-redirect
7051 * - 'mw-changed-redirect-target': Edit changes redirect target
7052 * - 'mw-blank': Edit completely blanks the page
7053 * - 'mw-replace': Edit removes more than 90% of the content
7054 * - 'mw-rollback': Edit is a rollback, made through the rollback link or rollback API
7055 * - 'mw-undo': Edit made through an undo link
7061 'mw-contentmodelchange' => true,
7062 'mw-new-redirect' => true,
7063 'mw-removed-redirect' => true,
7064 'mw-changed-redirect-target' => true,
7066 'mw-replace' => true,
7067 'mw-rollback' => true,
7072 * If set to an integer, pages that are watched by this many users or more
7073 * will not require the unwatchedpages permission to view the number of
7078 $wgUnwatchedPageThreshold = false;
7081 * Flags (letter symbols) shown in recent changes and watchlist to indicate
7082 * certain types of edits.
7084 * To register a new one:
7086 * $wgRecentChangesFlags['flag'] => [
7087 * // message for the letter displayed next to rows on changes lists
7088 * 'letter' => 'letter-msg',
7089 * // message for the tooltip of the letter
7090 * 'title' => 'tooltip-msg',
7091 * // optional (defaults to 'tooltip-msg'), message to use in the legend box
7092 * 'legend' => 'legend-msg',
7093 * // optional (defaults to 'flag'), CSS class to put on changes lists rows
7094 * 'class' => 'css-class',
7095 * // optional (defaults to 'any'), how top-level flag is determined. 'any'
7096 * // will set the top-level flag if any line contains the flag, 'all' will
7097 * // only be set if all lines contain the flag.
7098 * 'grouping' => 'any',
7104 $wgRecentChangesFlags = [
7106 'letter' => 'newpageletter',
7107 'title' => 'recentchanges-label-newpage',
7108 'legend' => 'recentchanges-legend-newpage',
7109 'grouping' => 'any',
7112 'letter' => 'minoreditletter',
7113 'title' => 'recentchanges-label-minor',
7114 'legend' => 'recentchanges-legend-minor',
7115 'class' => 'minoredit',
7116 'grouping' => 'all',
7119 'letter' => 'boteditletter',
7120 'title' => 'recentchanges-label-bot',
7121 'legend' => 'recentchanges-legend-bot',
7122 'class' => 'botedit',
7123 'grouping' => 'all',
7126 'letter' => 'unpatrolledletter',
7127 'title' => 'recentchanges-label-unpatrolled',
7128 'legend' => 'recentchanges-legend-unpatrolled',
7129 'grouping' => 'any',
7133 /** @} */ # end RC/watchlist }
7135 /************************************************************************//**
7136 * @name Copyright and credits settings
7141 * Override for copyright metadata.
7143 * This is the name of the page containing information about the wiki's copyright status,
7144 * which will be added as a link in the footer if it is specified. It overrides
7145 * $wgRightsUrl if both are specified.
7147 $wgRightsPage = null;
7150 * Set this to specify an external URL containing details about the content license used on your
7152 * If $wgRightsPage is set then this setting is ignored.
7154 $wgRightsUrl = null;
7157 * If either $wgRightsUrl or $wgRightsPage is specified then this variable gives the text for the
7158 * link. Otherwise, it will be treated as raw HTML.
7159 * If using $wgRightsUrl then this value must be specified. If using $wgRightsPage then the name
7160 * of the page will also be used as the link if this variable is not set.
7162 $wgRightsText = null;
7165 * Override for copyright metadata.
7167 $wgRightsIcon = null;
7170 * Set this to true if you want detailed copyright information forms on Upload.
7172 $wgUseCopyrightUpload = false;
7175 * Set this to the number of authors that you want to be credited below an
7176 * article text. Set it to zero to hide the attribution block, and a negative
7177 * number (like -1) to show all authors. Note that this will require 2-3 extra
7178 * database hits, which can have a not insignificant impact on performance for
7184 * If there are more than $wgMaxCredits authors, show $wgMaxCredits of them.
7185 * Otherwise, link to a separate credits page.
7187 $wgShowCreditsIfMax = true;
7189 /** @} */ # end of copyright and credits settings }
7191 /************************************************************************//**
7192 * @name Import / Export
7197 * List of interwiki prefixes for wikis we'll accept as sources for
7198 * Special:Import and API action=import. Since complete page history can be
7199 * imported, these should be 'trusted'.
7201 * This can either be a regular array, or an associative map specifying
7202 * subprojects on the interwiki map of the target wiki, or a mix of the two,
7205 * $wgImportSources = [
7206 * 'wikipedia' => [ 'cs', 'en', 'fr', 'zh' ],
7208 * 'wikia' => [ 'animanga', 'brickipedia', 'desserts' ],
7212 * If you have a very complex import sources setup, you can lazy-load it using
7213 * the ImportSources hook.
7215 * If a user has the 'import' permission but not the 'importupload' permission,
7216 * they will only be able to run imports through this transwiki interface.
7218 $wgImportSources = [];
7221 * Optional default target namespace for interwiki imports.
7222 * Can use this to create an incoming "transwiki"-style queue.
7223 * Set to numeric key, not the name.
7225 * Users may override this in the Special:Import dialog.
7227 $wgImportTargetNamespace = null;
7230 * If set to false, disables the full-history option on Special:Export.
7231 * This is currently poorly optimized for long edit histories, so is
7232 * disabled on Wikimedia's sites.
7234 $wgExportAllowHistory = true;
7237 * If set nonzero, Special:Export requests for history of pages with
7238 * more revisions than this will be rejected. On some big sites things
7239 * could get bogged down by very very long pages.
7241 $wgExportMaxHistory = 0;
7244 * Return distinct author list (when not returning full history)
7246 $wgExportAllowListContributors = false;
7249 * If non-zero, Special:Export accepts a "pagelink-depth" parameter
7250 * up to this specified level, which will cause it to include all
7251 * pages linked to from the pages you specify. Since this number
7252 * can become *insanely large* and could easily break your wiki,
7253 * it's disabled by default for now.
7255 * @warning There's a HARD CODED limit of 5 levels of recursion to prevent a
7256 * crazy-big export from being done by someone setting the depth number too
7257 * high. In other words, last resort safety net.
7259 $wgExportMaxLinkDepth = 0;
7262 * Whether to allow the "export all pages in namespace" option
7264 $wgExportFromNamespaces = false;
7267 * Whether to allow exporting the entire wiki into a single file
7269 $wgExportAllowAll = false;
7272 * Maximum number of pages returned by the GetPagesFromCategory and
7273 * GetPagesFromNamespace functions.
7277 $wgExportPagelistLimit = 5000;
7279 /** @} */ # end of import/export }
7281 /*************************************************************************//**
7287 * A list of callback functions which are called once MediaWiki is fully
7290 $wgExtensionFunctions = [];
7293 * Extension messages files.
7295 * Associative array mapping extension name to the filename where messages can be
7296 * found. The file should contain variable assignments. Any of the variables
7297 * present in languages/messages/MessagesEn.php may be defined, but $messages
7298 * is the most common.
7300 * Variables defined in extensions will override conflicting variables defined
7303 * Since MediaWiki 1.23, use of this variable to define messages is discouraged; instead, store
7304 * messages in JSON format and use $wgMessagesDirs. For setting other variables than
7305 * $messages, $wgExtensionMessagesFiles should still be used. Use a DIFFERENT key because
7306 * any entry having a key that also exists in $wgMessagesDirs will be ignored.
7308 * Extensions using the JSON message format can preserve backward compatibility with
7309 * earlier versions of MediaWiki by using a compatibility shim, such as one generated
7310 * by the generateJsonI18n.php maintenance script, listing it under the SAME key
7311 * as for the $wgMessagesDirs entry.
7315 * $wgExtensionMessagesFiles['ConfirmEdit'] = __DIR__.'/ConfirmEdit.i18n.php';
7318 $wgExtensionMessagesFiles = [];
7321 * Extension messages directories.
7323 * Associative array mapping extension name to the path of the directory where message files can
7324 * be found. The message files are expected to be JSON files named for their language code, e.g.
7325 * en.json, de.json, etc. Extensions with messages in multiple places may specify an array of
7326 * message directories.
7328 * Message directories in core should be added to LocalisationCache::getMessagesDirs()
7330 * @par Simple example:
7332 * $wgMessagesDirs['Example'] = __DIR__ . '/i18n';
7335 * @par Complex example:
7337 * $wgMessagesDirs['Example'] = [
7338 * __DIR__ . '/lib/ve/i18n',
7339 * __DIR__ . '/lib/ooui/i18n',
7340 * __DIR__ . '/i18n',
7345 $wgMessagesDirs = [];
7348 * Array of files with list(s) of extension entry points to be used in
7349 * maintenance/mergeMessageFileList.php
7352 $wgExtensionEntryPointListFiles = [];
7355 * Parser output hooks.
7356 * This is an associative array where the key is an extension-defined tag
7357 * (typically the extension name), and the value is a PHP callback.
7358 * These will be called as an OutputPageParserOutput hook, if the relevant
7359 * tag has been registered with the parser output object.
7361 * Registration is done with $pout->addOutputHook( $tag, $data ).
7363 * The callback has the form:
7365 * function outputHook( $outputPage, $parserOutput, $data ) { ... }
7368 $wgParserOutputHooks = [];
7371 * Whether to include the NewPP limit report as a HTML comment
7373 $wgEnableParserLimitReporting = true;
7376 * List of valid skin names
7378 * The key should be the name in all lower case, the value should be a properly
7379 * cased name for the skin. This value will be prefixed with "Skin" to create
7380 * the class name of the skin to load. Use Skin::getSkinNames() as an accessor
7381 * if you wish to have access to the full list.
7383 $wgValidSkinNames = [];
7386 * Special page list. This is an associative array mapping the (canonical) names of
7387 * special pages to either a class name to be instantiated, or a callback to use for
7388 * creating the special page object. In both cases, the result must be an instance of
7391 $wgSpecialPages = [];
7394 * Array mapping class names to filenames, for autoloading.
7396 $wgAutoloadClasses = $wgAutoloadClasses ??
[];
7399 * Switch controlling legacy case-insensitive classloading.
7400 * Do not disable if your wiki must support data created by PHP4, or by
7401 * MediaWiki 1.4 or earlier.
7403 $wgAutoloadAttemptLowercase = true;
7406 * An array of information about installed extensions keyed by their type.
7408 * All but 'name', 'path' and 'author' can be omitted.
7411 * $wgExtensionCredits[$type][] = [
7412 * 'path' => __FILE__,
7413 * 'name' => 'Example extension',
7414 * 'namemsg' => 'exampleextension-name',
7418 * 'version' => '1.9.0',
7419 * 'url' => 'https://example.org/example-extension/',
7420 * 'descriptionmsg' => 'exampleextension-desc',
7421 * 'license-name' => 'GPL-2.0-or-later',
7425 * The extensions are listed on Special:Version. This page also looks for a file
7426 * named COPYING or LICENSE (optional .txt extension) and provides a link to
7427 * view said file. When the 'license-name' key is specified, this file is
7428 * interpreted as wikitext.
7430 * - $type: One of 'specialpage', 'parserhook', 'variable', 'media', 'antispam',
7431 * 'skin', 'api', or 'other', or any additional types as specified through the
7432 * ExtensionTypes hook as used in SpecialVersion::getExtensionTypes().
7434 * - name: Name of extension as an inline string instead of localizable message.
7435 * Do not omit this even if 'namemsg' is provided, as it is used to override
7436 * the path Special:Version uses to find extension's license info, and is
7437 * required for backwards-compatibility with MediaWiki 1.23 and older.
7439 * - namemsg (since MW 1.24): A message key for a message containing the
7440 * extension's name, if the name is localizable. (For example, skin names
7443 * - author: A string or an array of strings. Authors can be linked using
7444 * the regular wikitext link syntax. To have an internationalized version of
7445 * "and others" show, add an element "...". This element can also be linked,
7446 * for instance "[https://example ...]".
7448 * - descriptionmsg: A message key or an an array with message key and parameters:
7449 * `'descriptionmsg' => 'exampleextension-desc',`
7451 * - description: Description of extension as an inline string instead of
7452 * localizable message (omit in favour of 'descriptionmsg').
7454 * - license-name: Short name of the license (used as label for the link), such
7455 * as "GPL-2.0-or-later" or "MIT" (https://spdx.org/licenses/ for a list of identifiers).
7457 $wgExtensionCredits = [];
7460 * Global list of hooks.
7462 * The key is one of the events made available by MediaWiki, you can find
7463 * a description for most of them in docs/hooks.txt. The array is used
7464 * internally by Hook:run().
7466 * The value can be one of:
7468 * - A function name:
7470 * $wgHooks['event_name'][] = $function;
7472 * - A function with some data:
7474 * $wgHooks['event_name'][] = [ $function, $data ];
7476 * - A an object method:
7478 * $wgHooks['event_name'][] = [ $object, 'method' ];
7482 * $wgHooks['event_name'][] = function ( $hookParam ) {
7483 * // Handler code goes here.
7487 * @warning You should always append to an event array or you will end up
7488 * deleting a previous registered hook.
7490 * @warning Hook handlers should be registered at file scope. Registering
7491 * handlers after file scope can lead to unexpected results due to caching.
7496 * List of service wiring files to be loaded by the default instance of MediaWikiServices.
7497 * Each file listed here is expected to return an associative array mapping service names
7498 * to instantiator functions. Extensions may add wiring files to define their own services.
7499 * However, this cannot be used to replace existing services - use the MediaWikiServices
7502 * @see MediaWikiServices
7503 * @see ServiceContainer::loadWiringFiles() for details on loading service instantiator functions.
7504 * @see docs/injection.txt for an overview of dependency injection in MediaWiki.
7506 $wgServiceWiringFiles = [
7507 __DIR__
. '/ServiceWiring.php'
7511 * Maps jobs to their handlers; extensions
7512 * can add to this to provide custom jobs.
7513 * A job handler should either be a class name to be instantiated,
7514 * or (since 1.30) a callback to use for creating the job object.
7515 * The callback takes (Title, array map of parameters) as arguments.
7518 'deletePage' => DeletePageJob
::class,
7519 'refreshLinks' => RefreshLinksJob
::class,
7520 'deleteLinks' => DeleteLinksJob
::class,
7521 'htmlCacheUpdate' => HTMLCacheUpdateJob
::class,
7522 'sendMail' => EmaillingJob
::class,
7523 'enotifNotify' => EnotifNotifyJob
::class,
7524 'fixDoubleRedirect' => DoubleRedirectJob
::class,
7525 'AssembleUploadChunks' => AssembleUploadChunksJob
::class,
7526 'PublishStashedFile' => PublishStashedFileJob
::class,
7527 'ThumbnailRender' => ThumbnailRenderJob
::class,
7528 'recentChangesUpdate' => RecentChangesUpdateJob
::class,
7529 'refreshLinksPrioritized' => RefreshLinksJob
::class,
7530 'refreshLinksDynamic' => RefreshLinksJob
::class,
7531 'activityUpdateJob' => ActivityUpdateJob
::class,
7532 'categoryMembershipChange' => function ( Title
$title, $params = [] ) {
7533 $pc = MediaWikiServices
::getInstance()->getParserCache();
7534 return new CategoryMembershipChangeJob( $pc, $title, $params );
7536 'clearUserWatchlist' => ClearUserWatchlistJob
::class,
7537 'cdnPurge' => CdnPurgeJob
::class,
7538 'userGroupExpiry' => UserGroupExpiryJob
::class,
7539 'clearWatchlistNotifications' => ClearWatchlistNotificationsJob
::class,
7540 'userOptionsUpdate' => UserOptionsUpdateJob
::class,
7541 'enqueue' => EnqueueJob
::class, // local queue for multi-DC setups
7542 'null' => NullJob
::class,
7546 * Jobs that must be explicitly requested, i.e. aren't run by job runners unless
7547 * special flags are set. The values here are keys of $wgJobClasses.
7550 * - Very long-running jobs.
7551 * - Jobs that you would never want to run as part of a page rendering request.
7552 * - Jobs that you want to run on specialized machines ( like transcoding, or a particular
7553 * machine on your cluster has 'outside' web access you could restrict uploadFromUrl )
7554 * These settings should be global to all wikis.
7556 $wgJobTypesExcludedFromDefaultQueue = [ 'AssembleUploadChunks', 'PublishStashedFile' ];
7559 * Map of job types to how many job "work items" should be run per second
7560 * on each job runner process. The meaning of "work items" varies per job,
7561 * but typically would be something like "pages to update". A single job
7562 * may have a variable number of work items, as is the case with batch jobs.
7563 * This is used by runJobs.php and not jobs run via $wgJobRunRate.
7564 * These settings should be global to all wikis.
7567 $wgJobBackoffThrottling = [];
7570 * Make job runners commit changes for replica DB-lag prone jobs one job at a time.
7571 * This is useful if there are many job workers that race on replica DB lag checks.
7572 * If set, jobs taking this many seconds of DB write time have serialized commits.
7574 * Note that affected jobs may have worse lock contention. Also, if they affect
7575 * several DBs at once they may have a smaller chance of being atomic due to the
7576 * possibility of connection loss while queueing up to commit. Affected jobs may
7577 * also fail due to the commit lock acquisition timeout.
7582 $wgJobSerialCommitThreshold = false;
7585 * Map of job types to configuration arrays.
7586 * This determines which queue class and storage system is used for each job type.
7587 * Job types that do not have explicit configuration will use the 'default' config.
7588 * These settings should be global to all wikis.
7591 'default' => [ 'class' => JobQueueDB
::class, 'order' => 'random', 'claimTTL' => 3600 ],
7595 * Whether to include the number of jobs that are queued
7596 * for the API's maxlag parameter.
7597 * The total number of jobs will be divided by this to get an
7598 * estimated second of maxlag. Typically bots backoff at maxlag=5,
7599 * so setting this to the max number of jobs that should be in your
7600 * queue divided by 5 should have the effect of stopping bots once
7601 * that limit is hit.
7605 $wgJobQueueIncludeInMaxLagFactor = false;
7608 * Additional functions to be performed with updateSpecialPages.
7609 * Expensive Querypages are already updated.
7611 $wgSpecialPageCacheUpdates = [
7612 'Statistics' => [ SiteStatsUpdate
::class, 'cacheUpdate' ]
7616 * Page property link table invalidation lists. When a page property
7617 * changes, this may require other link tables to be updated (eg
7618 * adding __HIDDENCAT__ means the hiddencat tracking category will
7619 * have been added, so the categorylinks table needs to be rebuilt).
7620 * This array can be added to by extensions.
7622 $wgPagePropLinkInvalidations = [
7623 'hiddencat' => 'categorylinks',
7626 /** @} */ # End extensions }
7628 /*************************************************************************//**
7634 * Use experimental, DMOZ-like category browser
7636 $wgUseCategoryBrowser = false;
7639 * On category pages, show thumbnail gallery for images belonging to that
7640 * category instead of listing them as articles.
7642 $wgCategoryMagicGallery = true;
7645 * Paging limit for categories
7647 $wgCategoryPagingLimit = 200;
7650 * Specify how category names should be sorted, when listed on a category page.
7651 * A sorting scheme is also known as a collation.
7653 * Available values are:
7655 * - uppercase: Converts the category name to upper case, and sorts by that.
7657 * - identity: Does no conversion. Sorts by binary value of the string.
7659 * - uca-default: Provides access to the Unicode Collation Algorithm with
7660 * the default element table. This is a compromise collation which sorts
7661 * all languages in a mediocre way. However, it is better than "uppercase".
7663 * To use the uca-default collation, you must have PHP's intl extension
7664 * installed. See https://www.php.net/manual/en/intl.setup.php . The details of the
7665 * resulting collation will depend on the version of ICU installed on the
7668 * After you change this, you must run maintenance/updateCollation.php to fix
7669 * the sort keys in the database.
7671 * Extensions can define there own collations by subclassing Collation
7672 * and using the Collation::factory hook.
7674 $wgCategoryCollation = 'uppercase';
7676 /** @} */ # End categories }
7678 /*************************************************************************//**
7684 * The logging system has two levels: an event type, which describes the
7685 * general category and can be viewed as a named subset of all logs; and
7686 * an action, which is a specific kind of event that can exist in that
7689 * Note that code should call LogPage::validTypes() to get a list of valid
7690 * log types instead of checking the global variable.
7710 * This restricts log access to those who have a certain right
7711 * Users without this will not see it in the option menu and can not view it
7712 * Restricted logs are not added to recent changes
7713 * Logs should remain non-transcludable
7714 * Format: logtype => permissiontype
7716 $wgLogRestrictions = [
7717 'suppress' => 'suppressionlog'
7721 * Show/hide links on Special:Log will be shown for these log types.
7723 * This is associative array of log type => boolean "hide by default"
7725 * See $wgLogTypes for a list of available log types.
7729 * $wgFilterLogTypes = [ 'move' => true, 'import' => false ];
7732 * Will display show/hide links for the move and import logs. Move logs will be
7733 * hidden by default unless the link is clicked. Import logs will be shown by
7734 * default, and hidden when the link is clicked.
7736 * A message of the form logeventslist-[type]-log should be added, and will be
7737 * used for the link text.
7739 $wgFilterLogTypes = [
7745 * Lists the message key string for each log type. The localized messages
7746 * will be listed in the user interface.
7748 * Extensions with custom log types may add to this array.
7750 * @since 1.19, if you follow the naming convention log-name-TYPE,
7751 * where TYPE is your log type, yoy don't need to use this array.
7754 '' => 'all-logs-page',
7755 'block' => 'blocklogpage',
7756 'protect' => 'protectlogpage',
7757 'rights' => 'rightslog',
7758 'delete' => 'dellogpage',
7759 'upload' => 'uploadlogpage',
7760 'move' => 'movelogpage',
7761 'import' => 'importlogpage',
7762 'patrol' => 'patrol-log-page',
7763 'merge' => 'mergelog',
7764 'suppress' => 'suppressionlog',
7768 * Lists the message key string for descriptive text to be shown at the
7769 * top of each log type.
7771 * Extensions with custom log types may add to this array.
7773 * @since 1.19, if you follow the naming convention log-description-TYPE,
7774 * where TYPE is your log type, yoy don't need to use this array.
7777 '' => 'alllogstext',
7778 'block' => 'blocklogtext',
7779 'delete' => 'dellogpagetext',
7780 'import' => 'importlogpagetext',
7781 'merge' => 'mergelogpagetext',
7782 'move' => 'movelogpagetext',
7783 'patrol' => 'patrol-log-header',
7784 'protect' => 'protectlogtext',
7785 'rights' => 'rightslogtext',
7786 'suppress' => 'suppressionlogtext',
7787 'upload' => 'uploadlogpagetext',
7791 * Lists the message key string for formatting individual events of each
7792 * type and action when listed in the logs.
7794 * Extensions with custom log types may add to this array.
7799 * The same as above, but here values are names of classes,
7801 * @see LogPage::actionText
7804 $wgLogActionsHandlers = [
7805 'block/block' => BlockLogFormatter
::class,
7806 'block/reblock' => BlockLogFormatter
::class,
7807 'block/unblock' => BlockLogFormatter
::class,
7808 'contentmodel/change' => ContentModelLogFormatter
::class,
7809 'contentmodel/new' => ContentModelLogFormatter
::class,
7810 'delete/delete' => DeleteLogFormatter
::class,
7811 'delete/delete_redir' => DeleteLogFormatter
::class,
7812 'delete/event' => DeleteLogFormatter
::class,
7813 'delete/restore' => DeleteLogFormatter
::class,
7814 'delete/revision' => DeleteLogFormatter
::class,
7815 'import/interwiki' => ImportLogFormatter
::class,
7816 'import/upload' => ImportLogFormatter
::class,
7817 'managetags/activate' => LogFormatter
::class,
7818 'managetags/create' => LogFormatter
::class,
7819 'managetags/deactivate' => LogFormatter
::class,
7820 'managetags/delete' => LogFormatter
::class,
7821 'merge/merge' => MergeLogFormatter
::class,
7822 'move/move' => MoveLogFormatter
::class,
7823 'move/move_redir' => MoveLogFormatter
::class,
7824 'patrol/patrol' => PatrolLogFormatter
::class,
7825 'patrol/autopatrol' => PatrolLogFormatter
::class,
7826 'protect/modify' => ProtectLogFormatter
::class,
7827 'protect/move_prot' => ProtectLogFormatter
::class,
7828 'protect/protect' => ProtectLogFormatter
::class,
7829 'protect/unprotect' => ProtectLogFormatter
::class,
7830 'rights/autopromote' => RightsLogFormatter
::class,
7831 'rights/rights' => RightsLogFormatter
::class,
7832 'suppress/block' => BlockLogFormatter
::class,
7833 'suppress/delete' => DeleteLogFormatter
::class,
7834 'suppress/event' => DeleteLogFormatter
::class,
7835 'suppress/reblock' => BlockLogFormatter
::class,
7836 'suppress/revision' => DeleteLogFormatter
::class,
7837 'tag/update' => TagLogFormatter
::class,
7838 'upload/overwrite' => UploadLogFormatter
::class,
7839 'upload/revert' => UploadLogFormatter
::class,
7840 'upload/upload' => UploadLogFormatter
::class,
7844 * List of log types that can be filtered by action types
7846 * To each action is associated the list of log_action
7847 * subtypes to search for, usually one, but not necessarily so
7848 * Extensions may append to this array
7851 $wgActionFilteredLogs = [
7853 'block' => [ 'block' ],
7854 'reblock' => [ 'reblock' ],
7855 'unblock' => [ 'unblock' ],
7858 'change' => [ 'change' ],
7862 'delete' => [ 'delete' ],
7863 'delete_redir' => [ 'delete_redir' ],
7864 'restore' => [ 'restore' ],
7865 'event' => [ 'event' ],
7866 'revision' => [ 'revision' ],
7869 'interwiki' => [ 'interwiki' ],
7870 'upload' => [ 'upload' ],
7873 'create' => [ 'create' ],
7874 'delete' => [ 'delete' ],
7875 'activate' => [ 'activate' ],
7876 'deactivate' => [ 'deactivate' ],
7879 'move' => [ 'move' ],
7880 'move_redir' => [ 'move_redir' ],
7883 'create' => [ 'create', 'newusers' ],
7884 'create2' => [ 'create2' ],
7885 'autocreate' => [ 'autocreate' ],
7886 'byemail' => [ 'byemail' ],
7889 'protect' => [ 'protect' ],
7890 'modify' => [ 'modify' ],
7891 'unprotect' => [ 'unprotect' ],
7892 'move_prot' => [ 'move_prot' ],
7895 'rights' => [ 'rights' ],
7896 'autopromote' => [ 'autopromote' ],
7899 'event' => [ 'event' ],
7900 'revision' => [ 'revision' ],
7901 'delete' => [ 'delete' ],
7902 'block' => [ 'block' ],
7903 'reblock' => [ 'reblock' ],
7906 'upload' => [ 'upload' ],
7907 'overwrite' => [ 'overwrite' ],
7908 'revert' => [ 'revert' ],
7913 * Maintain a log of newusers at Special:Log/newusers?
7915 $wgNewUserLog = true;
7918 * Maintain a log of page creations at Special:Log/create?
7921 $wgPageCreationLog = true;
7923 /** @} */ # end logging }
7925 /*************************************************************************//**
7926 * @name Special pages (general and miscellaneous)
7931 * Allow special page inclusions such as {{Special:Allpages}}
7933 $wgAllowSpecialInclusion = true;
7936 * Set this to an array of special page names to prevent
7937 * maintenance/updateSpecialPages.php from updating those pages.
7939 $wgDisableQueryPageUpdate = false;
7942 * On Special:Unusedimages, consider images "used", if they are put
7943 * into a category. Default (false) is not to count those as used.
7945 $wgCountCategorizedImagesAsUsed = false;
7948 * Maximum number of links to a redirect page listed on
7949 * Special:Whatlinkshere/RedirectDestination
7951 $wgMaxRedirectLinksRetrieved = 500;
7953 /** @} */ # end special pages }
7955 /*************************************************************************//**
7961 * Array of allowed values for the "title=foo&action=<action>" parameter. Syntax is:
7962 * 'foo' => 'ClassName' Load the specified class which subclasses Action
7963 * 'foo' => true Load the class FooAction which subclasses Action
7964 * If something is specified in the getActionOverrides()
7965 * of the relevant Page object it will be used
7966 * instead of the default class.
7967 * 'foo' => false The action is disabled; show an error message
7968 * Unsetting core actions will probably cause things to complain loudly.
7974 'editchangetags' => SpecialPageAction
::class,
7977 'markpatrolled' => true,
7978 'mcrundo' => McrUndoAction
::class,
7979 'mcrrestore' => McrRestoreAction
::class,
7985 'revisiondelete' => SpecialPageAction
::class,
7988 'unprotect' => true,
7994 /** @} */ # end actions }
7996 /*************************************************************************//**
7997 * @name Robot (search engine crawler) policy
7998 * See also $wgNoFollowLinks.
8003 * Default robot policy. The default policy is to encourage indexing and fol-
8004 * lowing of links. It may be overridden on a per-namespace and/or per-page
8007 $wgDefaultRobotPolicy = 'index,follow';
8010 * Robot policies per namespaces. The default policy is given above, the array
8011 * is made of namespace constants as defined in includes/Defines.php. You can-
8012 * not specify a different default policy for NS_SPECIAL: it is always noindex,
8013 * nofollow. This is because a number of special pages (e.g., ListPages) have
8014 * many permutations of options that display the same data under redundant
8015 * URLs, so search engine spiders risk getting lost in a maze of twisty special
8016 * pages, all alike, and never reaching your actual content.
8020 * $wgNamespaceRobotPolicies = [ NS_TALK => 'noindex' ];
8023 $wgNamespaceRobotPolicies = [];
8026 * Robot policies per article. These override the per-namespace robot policies.
8027 * Must be in the form of an array where the key part is a properly canonicalised
8028 * text form title and the value is a robot policy.
8032 * $wgArticleRobotPolicies = [
8033 * 'Main Page' => 'noindex,follow',
8034 * 'User:Bob' => 'index,follow',
8038 * @par Example that DOES NOT WORK because the names are not canonical text
8041 * $wgArticleRobotPolicies = [
8042 * # Underscore, not space!
8043 * 'Main_Page' => 'noindex,follow',
8044 * # "Project", not the actual project name!
8045 * 'Project:X' => 'index,follow',
8046 * # Needs to be "Abc", not "abc" (unless $wgCapitalLinks is false for that namespace)!
8047 * 'abc' => 'noindex,nofollow'
8051 $wgArticleRobotPolicies = [];
8054 * An array of namespace keys in which the __INDEX__/__NOINDEX__ magic words
8055 * will not function, so users can't decide whether pages in that namespace are
8056 * indexed by search engines. If set to null, default to $wgContentNamespaces.
8060 * $wgExemptFromUserRobotsControl = [ NS_MAIN, NS_TALK, NS_PROJECT ];
8063 $wgExemptFromUserRobotsControl = null;
8065 /** @} */ # End robot policy }
8067 /************************************************************************//**
8068 * @name AJAX, Action API and REST API
8069 * Note: The AJAX entry point which this section refers to is gradually being
8070 * replaced by the Action API entry point, api.php. They are essentially
8071 * equivalent. Both of them are used for dynamic client-side features, via XHR.
8077 * WARNING: SECURITY THREAT - debug use only
8079 * Disables many security checks in the API for debugging purposes.
8080 * This flag should never be used on the production servers, as it introduces
8081 * a number of potential security holes. Even when enabled, the validation
8082 * will still be performed, but instead of failing, API will return a warning.
8083 * Also, there will always be a warning notifying that this flag is set.
8084 * At this point, the flag allows GET requests to go through for modules
8089 $wgDebugAPI = false;
8092 * API module extensions.
8094 * Associative array mapping module name to modules specs;
8095 * Each module spec is an associative array containing at least
8096 * the 'class' key for the module's class, and optionally a
8097 * 'factory' key for the factory function to use for the module.
8099 * That factory function will be called with two parameters,
8100 * the parent module (an instance of ApiBase, usually ApiMain)
8101 * and the name the module was registered under. The return
8102 * value must be an instance of the class given in the 'class'
8105 * For backward compatibility, the module spec may also be a
8106 * simple string containing the module's class name. In that
8107 * case, the class' constructor will be called with the parent
8108 * module and module name as parameters, as described above.
8110 * Examples for registering API modules:
8113 * $wgAPIModules['foo'] = 'ApiFoo';
8114 * $wgAPIModules['bar'] = [
8115 * 'class' => ApiBar::class,
8116 * 'factory' => function( $main, $name ) { ... }
8118 * $wgAPIModules['xyzzy'] = [
8119 * 'class' => ApiXyzzy::class,
8120 * 'factory' => [ XyzzyFactory::class, 'newApiModule' ]
8124 * Extension modules may override the core modules.
8125 * See ApiMain::$Modules for a list of the core modules.
8130 * API format module extensions.
8131 * Associative array mapping format module name to module specs (see $wgAPIModules).
8132 * Extension modules may override the core modules.
8134 * See ApiMain::$Formats for a list of the core format modules.
8136 $wgAPIFormatModules = [];
8139 * API Query meta module extensions.
8140 * Associative array mapping meta module name to module specs (see $wgAPIModules).
8141 * Extension modules may override the core modules.
8143 * See ApiQuery::$QueryMetaModules for a list of the core meta modules.
8145 $wgAPIMetaModules = [];
8148 * API Query prop module extensions.
8149 * Associative array mapping prop module name to module specs (see $wgAPIModules).
8150 * Extension modules may override the core modules.
8152 * See ApiQuery::$QueryPropModules for a list of the core prop modules.
8154 $wgAPIPropModules = [];
8157 * API Query list module extensions.
8158 * Associative array mapping list module name to module specs (see $wgAPIModules).
8159 * Extension modules may override the core modules.
8161 * See ApiQuery::$QueryListModules for a list of the core list modules.
8163 $wgAPIListModules = [];
8166 * Maximum amount of rows to scan in a DB query in the API
8167 * The default value is generally fine
8169 $wgAPIMaxDBRows = 5000;
8172 * The maximum size (in bytes) of an API result.
8173 * @warning Do not set this lower than $wgMaxArticleSize*1024
8175 $wgAPIMaxResultSize = 8388608;
8178 * The maximum number of uncached diffs that can be retrieved in one API
8179 * request. Set this to 0 to disable API diffs altogether
8181 $wgAPIMaxUncachedDiffs = 1;
8184 * Maximum amount of DB lag on a majority of DB replica DBs to tolerate
8185 * before forcing bots to retry any write requests via API errors.
8186 * This should be lower than the 'max lag' value in $wgLBFactoryConf.
8188 $wgAPIMaxLagThreshold = 7;
8191 * Log file or URL (TCP or UDP) to log API requests to, or false to disable
8192 * API request logging
8194 $wgAPIRequestLog = false;
8197 * Set the timeout for the API help text cache. If set to 0, caching disabled
8199 $wgAPICacheHelpTimeout = 60 * 60;
8202 * The ApiQueryQueryPages module should skip pages that are redundant to true
8205 $wgAPIUselessQueryPages = [
8206 'MIMEsearch', // aiprop=mime
8207 'LinkSearch', // list=exturlusage
8208 'FileDuplicateSearch', // prop=duplicatefiles
8212 * Enable AJAX framework
8214 * @deprecated (officially) since MediaWiki 1.31 and ignored since 1.32
8219 * List of Ajax-callable functions.
8220 * Extensions acting as Ajax callbacks must register here
8221 * @deprecated (officially) since 1.27; use the API instead
8223 $wgAjaxExportList = [];
8226 * Enable AJAX check for file overwrite, pre-upload
8228 $wgAjaxUploadDestCheck = true;
8231 * Enable previewing licences via AJAX.
8233 $wgAjaxLicensePreview = true;
8236 * Have clients send edits to be prepared when filling in edit summaries.
8237 * This gives the server a head start on the expensive parsing operation.
8239 $wgAjaxEditStash = true;
8242 * Settings for incoming cross-site AJAX requests:
8243 * Newer browsers support cross-site AJAX when the target resource allows requests
8244 * from the origin domain by the Access-Control-Allow-Origin header.
8245 * This is currently only used by the API (requests to api.php)
8246 * $wgCrossSiteAJAXdomains can be set using a wildcard syntax:
8248 * - '*' matches any number of characters
8249 * - '?' matches any 1 character
8253 * $wgCrossSiteAJAXdomains = [
8254 * 'www.mediawiki.org',
8255 * '*.wikipedia.org',
8256 * '*.wikimedia.org',
8257 * '*.wiktionary.org',
8261 $wgCrossSiteAJAXdomains = [];
8264 * Domains that should not be allowed to make AJAX requests,
8265 * even if they match one of the domains allowed by $wgCrossSiteAJAXdomains
8266 * Uses the same syntax as $wgCrossSiteAJAXdomains
8268 $wgCrossSiteAJAXdomainExceptions = [];
8271 * Enable the experimental REST API.
8273 * This will be removed once the REST API is stable and used by clients.
8275 $wgEnableRestAPI = false;
8277 /** @} */ # End AJAX and API }
8279 /************************************************************************//**
8280 * @name Shell and process control
8285 * Maximum amount of virtual memory available to shell processes under linux, in KB.
8287 $wgMaxShellMemory = 307200;
8290 * Maximum file size created by shell processes under linux, in KB
8291 * ImageMagick convert for example can be fairly hungry for scratch space
8293 $wgMaxShellFileSize = 102400;
8296 * Maximum CPU time in seconds for shell processes under Linux
8298 $wgMaxShellTime = 180;
8301 * Maximum wall clock time (i.e. real time, of the kind the clock on the wall
8302 * would measure) in seconds for shell processes under Linux
8304 $wgMaxShellWallClockTime = 180;
8307 * Under Linux: a cgroup directory used to constrain memory usage of shell
8308 * commands. The directory must be writable by the user which runs MediaWiki.
8310 * If specified, this is used instead of ulimit, which is inaccurate, and
8311 * causes malloc() to return NULL, which exposes bugs in C applications, making
8312 * them segfault or deadlock.
8314 * A wrapper script will create a cgroup for each shell command that runs, as
8315 * a subgroup of the specified cgroup. If the memory limit is exceeded, the
8316 * kernel will send a SIGKILL signal to a process in the subgroup.
8320 * mkdir -p /sys/fs/cgroup/memory/mediawiki
8321 * mkdir -m 0777 /sys/fs/cgroup/memory/mediawiki/job
8322 * echo '$wgShellCgroup = "/sys/fs/cgroup/memory/mediawiki/job";' >> LocalSettings.php
8325 * The reliability of cgroup cleanup can be improved by installing a
8326 * notify_on_release script in the root cgroup, see e.g.
8327 * https://gerrit.wikimedia.org/r/#/c/40784
8329 $wgShellCgroup = false;
8332 * Executable path of the PHP cli binary. Should be set up on install.
8334 $wgPhpCli = '/usr/bin/php';
8337 * Locale for LC_ALL, to provide a known environment for locale-sensitive operations
8339 * For Unix-like operating systems, this should be set to C.UTF-8 or an
8340 * equivalent to provide the most consistent behavior for locale-sensitive
8341 * C library operations across different-language wikis. If that locale is not
8342 * available, use another locale that has a UTF-8 character set.
8344 * This setting mainly affects the behavior of C library functions, including:
8345 * - String collation (order when sorting using locale-sensitive comparison)
8346 * - For example, whether "Å" and "A" are considered to be the same letter or
8347 * different letters and if different whether it comes after "A" or after
8348 * "Z", and whether sorting is case sensitive.
8349 * - String character set (how characters beyond basic ASCII are represented)
8350 * - We need this to be a UTF-8 character set to work around
8351 * https://bugs.php.net/bug.php?id=45132
8352 * - Language used for low-level error messages.
8353 * - Formatting of date/time and numeric values (e.g. '.' versus ',' as the
8354 * decimal separator)
8356 * MediaWiki provides its own methods and classes to perform many
8357 * locale-sensitive operations, which are designed to be able to vary locale
8358 * based on wiki language or user preference:
8359 * - MediaWiki's Collation class should generally be used instead of the C
8360 * library collation functions when locale-sensitive sorting is needed.
8361 * - MediaWiki's Message class should be used for localization of messages
8362 * displayed to the user.
8363 * - MediaWiki's Language class should be used for formatting numeric and
8366 * @note If multiple wikis are being served from the same process (e.g. the
8367 * same fastCGI or Apache server), this setting must be the same on all those
8370 $wgShellLocale = 'C.UTF-8';
8373 * Method to use to restrict shell commands
8375 * Supported options:
8376 * - 'autodetect': Autodetect if any restriction methods are available
8377 * - 'firejail': Use firejail <https://firejail.wordpress.com/>
8378 * - false: Don't use any restrictions
8380 * @note If using firejail with MediaWiki running in a home directory different
8381 * from the webserver user, firejail 0.9.44+ is required.
8386 $wgShellRestrictionMethod = false;
8388 /** @} */ # End shell }
8390 /************************************************************************//**
8396 * Timeout for HTTP requests done internally, in seconds.
8399 $wgHTTPTimeout = 25;
8402 * Timeout for HTTP requests done internally for transwiki imports, in seconds.
8405 $wgHTTPImportTimeout = 25;
8408 * Timeout for Asynchronous (background) HTTP requests, in seconds.
8410 $wgAsyncHTTPTimeout = 25;
8413 * Proxy to use for CURL requests.
8418 * Local virtual hosts.
8420 * This lists domains that are configured as virtual hosts on the same machine.
8422 * This affects the following:
8423 * - MWHttpRequest: If a request is to be made to a domain listed here, or any
8424 * subdomain thereof, then no proxy will be used.
8425 * Command-line scripts are not affected by this setting and will always use
8426 * the proxy if it is configured.
8430 $wgLocalVirtualHosts = [];
8433 * Timeout for connections done internally (in seconds)
8434 * Only works for curl
8436 $wgHTTPConnectTimeout = 5e0
;
8439 * Whether to respect/honour the request ID provided by the incoming request
8440 * via the `X-Request-Id` header. Set to `true` if the entity sitting in front
8441 * of Mediawiki sanitises external requests. Default: `false`.
8443 $wgAllowExternalReqID = false;
8445 /** @} */ # End HTTP client }
8447 /************************************************************************//**
8453 * Number of jobs to perform per request. May be less than one in which case
8454 * jobs are performed probabalistically. If this is zero, jobs will not be done
8455 * during ordinary apache requests. In this case, maintenance/runJobs.php should
8456 * be run periodically.
8461 * When $wgJobRunRate > 0, try to run jobs asynchronously, spawning a new process
8462 * to handle the job execution, instead of blocking the request until the job
8463 * execution finishes.
8467 $wgRunJobsAsync = false;
8470 * Number of rows to update per job
8472 $wgUpdateRowsPerJob = 300;
8475 * Number of rows to update per query
8477 $wgUpdateRowsPerQuery = 100;
8479 /** @} */ # End job queue }
8481 /************************************************************************//**
8482 * @name Miscellaneous
8487 * Name of the external diff engine to use. Supported values:
8488 * * string: path to an external diff executable
8489 * * false: wikidiff2 PHP/HHVM module if installed, otherwise the default PHP implementation
8490 * * 'wikidiff', 'wikidiff2', and 'wikidiff3' are treated as false for backwards compatibility
8492 $wgExternalDiffEngine = false;
8495 * wikidiff2 supports detection of changes in moved paragraphs.
8496 * This setting controls the maximum number of paragraphs to compare before it bails out.
8498 * * 0: detection of moved paragraphs is disabled
8499 * * int > 0: maximum number of paragraphs to compare
8500 * Note: number of paragraph comparisons is in O(n^2).
8501 * This setting is only effective if the wikidiff2 PHP/HHVM module is used as diffengine.
8502 * See $wgExternalDiffEngine.
8505 * @deprecated since 1.34
8507 $wgWikiDiff2MovedParagraphDetectionCutoff = 0;
8510 * Disable redirects to special pages and interwiki redirects, which use a 302
8511 * and have no "redirected from" link.
8513 * @note This is only for articles with #REDIRECT in them. URL's containing a
8514 * local interwiki prefix (or a non-canonical special page name) are still hard
8515 * redirected regardless of this setting.
8517 $wgDisableHardRedirects = false;
8520 * LinkHolderArray batch size
8523 $wgLinkHolderBatchSize = 1000;
8526 * By default MediaWiki does not register links pointing to same server in
8527 * externallinks dataset, use this value to override:
8529 $wgRegisterInternalExternals = false;
8532 * Maximum number of pages to move at once when moving subpages with a page.
8534 $wgMaximumMovedPages = 100;
8537 * Fix double redirects after a page move.
8538 * Tends to conflict with page move vandalism, use only on a private wiki.
8540 $wgFixDoubleRedirects = false;
8543 * Allow redirection to another page when a user logs in.
8544 * To enable, set to a string like 'Main Page'
8546 $wgRedirectOnLogin = null;
8549 * Configuration for processing pool control, for use in high-traffic wikis.
8550 * An implementation is provided in the PoolCounter extension.
8552 * This configuration array maps pool types to an associative array. The only
8553 * defined key in the associative array is "class", which gives the class name.
8554 * The remaining elements are passed through to the class as constructor
8557 * @par Example using local redis instance:
8559 * $wgPoolCounterConf = [ 'ArticleView' => [
8560 * 'class' => PoolCounterRedis::class,
8561 * 'timeout' => 15, // wait timeout in seconds
8562 * 'workers' => 1, // maximum number of active threads in each pool
8563 * 'maxqueue' => 5, // maximum number of total threads in each pool
8564 * 'servers' => [ '127.0.0.1' ],
8565 * 'redisConfig' => []
8569 * @par Example using C daemon from https://www.mediawiki.org/wiki/Extension:PoolCounter:
8571 * $wgPoolCounterConf = [ 'ArticleView' => [
8572 * 'class' => PoolCounter_Client::class,
8573 * 'timeout' => 15, // wait timeout in seconds
8574 * 'workers' => 5, // maximum number of active threads in each pool
8575 * 'maxqueue' => 50, // maximum number of total threads in each pool
8576 * ... any extension-specific options...
8580 $wgPoolCounterConf = null;
8583 * To disable file delete/restore temporarily
8585 $wgUploadMaintenance = false;
8588 * Associative array mapping namespace IDs to the name of the content model pages in that namespace
8589 * should have by default (use the CONTENT_MODEL_XXX constants). If no special content type is
8590 * defined for a given namespace, pages in that namespace will use the CONTENT_MODEL_WIKITEXT
8591 * (except for the special case of JS and CS pages).
8593 * @note To determine the default model for a new page's main slot, or any slot in general,
8594 * use SlotRoleHandler::getDefaultModel() together with SlotRoleRegistry::getRoleHandler().
8598 $wgNamespaceContentModels = [];
8601 * How to react if a plain text version of a non-text Content object is requested using
8602 * ContentHandler::getContentText():
8604 * * 'ignore': return null
8605 * * 'fail': throw an MWException
8606 * * 'serialize': serialize to default format
8610 $wgContentHandlerTextFallback = 'ignore';
8613 * Set to false to disable use of the database fields introduced by the ContentHandler facility.
8614 * This way, the ContentHandler facility can be used without any additional information in the
8615 * database. A page's content model is then derived solely from the page's title. This however
8616 * means that changing a page's default model (e.g. using $wgNamespaceContentModels) will break
8617 * the page and/or make the content inaccessible. This also means that pages can not be moved to
8618 * a title that would default to a different content model.
8620 * Overall, with $wgContentHandlerUseDB = false, no database updates are needed, but content
8621 * handling is less robust and less flexible.
8625 $wgContentHandlerUseDB = true;
8628 * Determines which types of text are parsed as wikitext. This does not imply that these kinds
8629 * of texts are also rendered as wikitext, it only means that links, magic words, etc will have
8630 * the effect on the database they would have on a wikitext page.
8632 * @todo On the long run, it would be nice to put categories etc into a separate structure,
8633 * or at least parse only the contents of comments in the scripts.
8637 $wgTextModelsToParse = [
8638 CONTENT_MODEL_WIKITEXT
, // Just for completeness, wikitext will always be parsed.
8639 CONTENT_MODEL_JAVASCRIPT
, // Make categories etc work, people put them into comments.
8640 CONTENT_MODEL_CSS
, // Make categories etc work, people put them into comments.
8644 * Register handlers for specific types of sites.
8649 'mediawiki' => MediaWikiSite
::class,
8653 * Whether the page_props table has a pp_sortkey column. Set to false in case
8654 * the respective database schema change was not applied.
8657 $wgPagePropsHaveSortkey = true;
8660 * For installations where the canonical server is HTTP but HTTPS is optionally
8661 * supported, you can specify a non-standard HTTPS port here. $wgServer should
8662 * be a protocol-relative URL.
8664 * If HTTPS is always used, just specify the port number in $wgServer.
8666 * @see https://phabricator.wikimedia.org/T67184
8673 * Secret for session storage.
8674 * This should be set in LocalSettings.php, otherwise wgSecretKey will
8678 $wgSessionSecret = false;
8681 * If for some reason you can't install the PHP OpenSSL or mcrypt extensions,
8682 * you can set this to true to make MediaWiki work again at the cost of storing
8683 * sensitive session data insecurely. But it would be much more secure to just
8684 * install the OpenSSL extension.
8687 $wgSessionInsecureSecrets = false;
8690 * Secret for hmac-based key derivation function (fast,
8691 * cryptographically secure random numbers).
8692 * This should be set in LocalSettings.php, otherwise wgSecretKey will
8694 * See also: $wgHKDFAlgorithm
8697 $wgHKDFSecret = false;
8700 * Algorithm for hmac-based key derivation function (fast,
8701 * cryptographically secure random numbers).
8702 * See also: $wgHKDFSecret
8705 $wgHKDFAlgorithm = 'sha256';
8708 * Enable page language feature
8709 * Allows setting page language in database
8713 $wgPageLanguageUseDB = false;
8716 * Global configuration variable for Virtual REST Services.
8718 * Use the 'path' key to define automatically mounted services. The value for this
8719 * key is a map of path prefixes to service configuration. The latter is an array of:
8720 * - class : the fully qualified class name
8721 * - options : map of arguments to the class constructor
8722 * Such services will be available to handle queries under their path from the VRS
8723 * singleton, e.g. MediaWikiServices::getInstance()->getVirtualRESTServiceClient();
8725 * Auto-mounting example for Parsoid:
8727 * $wgVirtualRestConfig['paths']['/parsoid/'] = [
8728 * 'class' => ParsoidVirtualRESTService::class,
8730 * 'url' => 'http://localhost:8000',
8731 * 'prefix' => 'enwiki',
8732 * 'domain' => 'en.wikipedia.org'
8736 * Parameters for different services can also be declared inside the 'modules' value,
8737 * which is to be treated as an associative array. The parameters in 'global' will be
8738 * merged with service-specific ones. The result will then be passed to
8739 * VirtualRESTService::__construct() in the module.
8741 * Example config for Parsoid:
8743 * $wgVirtualRestConfig['modules']['parsoid'] = [
8744 * 'url' => 'http://localhost:8000',
8745 * 'prefix' => 'enwiki',
8746 * 'domain' => 'en.wikipedia.org',
8752 $wgVirtualRestConfig = [
8756 # Timeout in seconds
8758 # 'domain' is set to $wgCanonicalServer in Setup.php
8759 'forwardCookies' => false,
8765 * Controls whether zero-result search queries with suggestions should display results for
8766 * these suggestions.
8771 $wgSearchRunSuggestedQuery = true;
8774 * Where popular password file is located.
8776 * Default in core contains 10,000 most popular. This config
8777 * allows you to change which file, in case you want to generate
8778 * a password file with > 10000 entries in it.
8780 * @see maintenance/createCommonPasswordCdb.php
8782 * @deprecated since 1.33
8783 * @var string path to file
8785 $wgPopularPasswordFile = __DIR__
. '/password/commonpasswords.cdb';
8788 * Max time (in seconds) a user-generated transaction can spend in writes.
8789 * If exceeded, the transaction is rolled back with an error instead of being committed.
8791 * @var int|bool Disabled if false
8794 $wgMaxUserDBWriteDuration = false;
8797 * Max time (in seconds) a job-generated transaction can spend in writes.
8798 * If exceeded, the transaction is rolled back with an error instead of being committed.
8800 * @var int|bool Disabled if false
8803 $wgMaxJobDBWriteDuration = false;
8806 * Controls Content-Security-Policy header [Experimental]
8808 * @see https://www.w3.org/TR/CSP2/
8810 * @var bool|array true to send default version, false to not send.
8811 * If an array, can have parameters:
8812 * 'default-src' If true or array (of additional urls) will set a default-src
8813 * directive, which limits what places things can load from. If false or not
8814 * set, will send a default-src directive allowing all sources.
8815 * 'includeCORS' If true or not set, will include urls from
8816 * $wgCrossSiteAJAXdomains as an allowed load sources.
8817 * 'unsafeFallback' Add unsafe-inline as a script source, as a fallback for
8818 * browsers that do not understand nonce-sources [default on].
8819 * 'useNonces' Require nonces on all inline scripts. If disabled and 'unsafeFallback'
8820 * is on, then all inline scripts will be allowed [default true].
8821 * 'script-src' Array of additional places that are allowed to have JS be loaded from.
8822 * 'report-uri' true to use MW api [default], false to disable, string for alternate uri
8823 * @warning May cause slowness on windows due to slow random number generator.
8825 $wgCSPHeader = false;
8828 * Controls Content-Security-Policy-Report-Only header
8831 * @var bool|array Same as $wgCSPHeader
8833 $wgCSPReportOnlyHeader = false;
8836 * List of messages which might contain raw HTML.
8837 * Extensions should add their messages here. The list is used for access control:
8838 * changing messages listed here will require editsitecss and editsitejs rights.
8840 * Message names must be given with underscores rather than spaces and with lowercase first letter.
8845 $wgRawHtmlMessages = [
8847 'history_copyright',
8850 'feedback-termsofuse',
8854 * Mapping of event channels (or channel categories) to EventRelayer configuration.
8856 * By setting up a PubSub system (like Kafka) and enabling a corresponding EventRelayer class
8857 * that uses it, MediaWiki can broadcast events to all subscribers. Certain features like WAN
8858 * cache purging and CDN cache purging will emit events to this system. Appropriate listers can
8859 * subscribe to the channel and take actions based on the events. For example, a local daemon
8860 * can run on each CDN cache node and perform local purges based on the URL purge channel events.
8862 * Some extensions may want to use "channel categories" so that different channels can also share
8863 * the same custom relayer instance (e.g. when it's likely to be overriden). They can use
8864 * EventRelayerGroup::getRelayer() based on the category but call notify() on various different
8865 * actual channels. One reason for this would be that some system have very different performance
8866 * vs durability needs, so one system (e.g. Kafka) may not be suitable for all uses.
8868 * The 'default' key is for all channels (or channel categories) without an explicit entry here.
8872 $wgEventRelayerConfig = [
8874 'class' => EventRelayerNull
::class,
8879 * Share data about this installation with MediaWiki developers
8881 * When set to true, MediaWiki will periodically ping https://www.mediawiki.org/ with basic
8882 * data about this MediaWiki instance. This data includes, for example, the type of system,
8883 * PHP version, and chosen database backend. The Wikimedia Foundation shares this data with
8884 * MediaWiki developers to help guide future development efforts.
8886 * For details about what data is sent, see: https://www.mediawiki.org/wiki/Manual:$wgPingback
8891 $wgPingback = false;
8894 * List of urls which appear often to be triggering CSP reports
8895 * but do not appear to be caused by actual content, but by client
8896 * software inserting scripts (i.e. Ad-Ware).
8897 * List based on results from Wikimedia logs.
8901 $wgCSPFalsePositiveUrls = [
8902 'https://3hub.co' => true,
8903 'https://morepro.info' => true,
8904 'https://p.ato.mx' => true,
8905 'https://s.ato.mx' => true,
8906 'https://adserver.adtech.de' => true,
8907 'https://ums.adtechus.com' => true,
8908 'https://cas.criteo.com' => true,
8909 'https://cat.nl.eu.criteo.com' => true,
8910 'https://atpixel.alephd.com' => true,
8911 'https://rtb.metrigo.com' => true,
8912 'https://d5p.de17a.com' => true,
8913 'https://ad.lkqd.net/vpaid/vpaid.js' => true,
8914 'https://ad.lkqd.net/vpaid/vpaid.js?fusion=1.0' => true,
8915 'https://t.lkqd.net/t' => true,
8916 'chrome-extension' => true,
8920 * Shortest CIDR limits that can be checked in any individual range check
8921 * at Special:Contributions.
8926 $wgRangeContributionsCIDRLimit = [
8932 * The following variables define 3 user experience levels:
8934 * - newcomer: has not yet reached the 'learner' level
8936 * - learner: has at least $wgLearnerEdits and has been
8937 * a member for $wgLearnerMemberSince days
8938 * but has not yet reached the 'experienced' level.
8940 * - experienced: has at least $wgExperiencedUserEdits edits and
8941 * has been a member for $wgExperiencedUserMemberSince days.
8943 $wgLearnerEdits = 10;
8944 $wgLearnerMemberSince = 4; # days
8945 $wgExperiencedUserEdits = 500;
8946 $wgExperiencedUserMemberSince = 30; # days
8949 * Mapping of interwiki index prefixes to descriptors that
8950 * can be used to change the display of interwiki search results.
8952 * Descriptors are appended to CSS classes of interwiki results
8953 * which using InterwikiSearchResultWidget.
8955 * Predefined descriptors include the following words:
8956 * definition, textbook, news, quotation, book, travel, course
8960 * $wgInterwikiPrefixDisplayTypes = [
8961 * 'iwprefix' => 'definition'
8965 $wgInterwikiPrefixDisplayTypes = [];
8968 * RevisionStore table schema migration stage (content, slots, content_models & slot_roles tables).
8969 * Use the SCHEMA_COMPAT_XXX flags. Supported values:
8971 * - SCHEMA_COMPAT_OLD
8972 * - SCHEMA_COMPAT_WRITE_BOTH | SCHEMA_COMPAT_READ_OLD
8973 * - SCHEMA_COMPAT_WRITE_BOTH | SCHEMA_COMPAT_READ_NEW
8974 * - SCHEMA_COMPAT_OLD
8976 * Note that reading the old and new schema at the same time is not supported.
8977 * Attempting to set both read bits in $wgMultiContentRevisionSchemaMigrationStage
8978 * will result in an InvalidArgumentException.
8980 * @see Task: https://phabricator.wikimedia.org/T174028
8981 * @see Commit: https://gerrit.wikimedia.org/r/#/c/378724/
8984 * @var int An appropriate combination of SCHEMA_COMPAT_XXX flags.
8986 $wgMultiContentRevisionSchemaMigrationStage = SCHEMA_COMPAT_WRITE_BOTH | SCHEMA_COMPAT_READ_NEW
;
8989 * The schema to use per default when generating XML dumps. This allows sites to control
8990 * explicitly when to make breaking changes to their export and dump format.
8992 $wgXmlDumpSchemaVersion = XML_DUMP_SCHEMA_VERSION_10
;
8995 * Actor table schema migration stage.
8997 * Use the SCHEMA_COMPAT_XXX flags. Supported values:
8998 * - SCHEMA_COMPAT_OLD
8999 * - SCHEMA_COMPAT_WRITE_BOTH | SCHEMA_COMPAT_READ_OLD
9000 * - SCHEMA_COMPAT_WRITE_BOTH | SCHEMA_COMPAT_READ_NEW
9001 * - SCHEMA_COMPAT_NEW
9003 * Note that reading the old and new schema at the same time is not supported
9004 * in 1.32, but was (with significant query performance issues) in 1.31.
9007 * @since 1.32 changed allowed flags
9008 * @var int An appropriate combination of SCHEMA_COMPAT_XXX flags.
9010 $wgActorTableSchemaMigrationStage = SCHEMA_COMPAT_NEW
;
9013 * Flag to enable Partial Blocks. This allows an admin to prevent a user from editing specific pages
9020 $wgEnablePartialBlocks = false;
9023 * Origin Trials tokens.
9028 $wgOriginTrials = [];
9031 * Enable client-side Priority Hints.
9033 * @warning EXPERIMENTAL!
9038 $wgPriorityHints = false;
9041 * Ratio of requests that should get Priority Hints when the feature is enabled.
9043 * @warning EXPERIMENTAL!
9048 $wgPriorityHintsRatio = 1.0;
9051 * Enable Element Timing.
9053 * @warning EXPERIMENTAL!
9058 $wgElementTiming = false;
9061 * Expiry of the endpoint definition for the Reporting API.
9063 * @warning EXPERIMENTAL!
9068 $wgReportToExpiry = 86400;
9071 * List of endpoints for the Reporting API.
9073 * @warning EXPERIMENTAL!
9078 $wgReportToEndpoints = [];
9081 * List of Feature Policy Reporting types to enable.
9082 * Each entry is turned into a Feature-Policy-Report-Only header.
9084 * @warning EXPERIMENTAL!
9089 $wgFeaturePolicyReportOnly = [];
9092 * Options for Special:Search completion widget form created by SearchFormWidget class.
9093 * Settings that can be used:
9094 * - showDescriptions: true/false - whether to show opensearch description results
9095 * - performSearchOnClick: true/false - whether to perform search on click
9096 * See also TitleWidget.js UI widget.
9100 $wgSpecialSearchFormOptions = [];
9103 * Toggles native image lazy loading, via the "loading" attribute.
9105 * @warning EXPERIMENTAL!
9110 $wgNativeImageLazyLoading = false;
9113 * For really cool vim folding this needs to be at the end:
9114 * vim: foldmarker=@{,@} foldmethod=marker