3 * Default values for MediaWiki configuration settings.
9 * To customize your installation, edit "LocalSettings.php". If you make
10 * changes here, they will be lost on next upgrade of MediaWiki!
12 * In this file, variables whose default values depend on other
13 * variables are set to false. The actual default value of these variables
14 * will only be set in Setup.php, taking into account any custom settings
15 * performed in LocalSettings.php.
17 * Documentation is in the source and on:
18 * https://www.mediawiki.org/wiki/Manual:Configuration_settings
20 * @warning Note: this (and other things) will break if the autoloader is not
21 * enabled. Please include includes/AutoLoader.php before including this file.
23 * This program is free software; you can redistribute it and/or modify
24 * it under the terms of the GNU General Public License as published by
25 * the Free Software Foundation; either version 2 of the License, or
26 * (at your option) any later version.
28 * This program is distributed in the hope that it will be useful,
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31 * GNU General Public License for more details.
33 * You should have received a copy of the GNU General Public License along
34 * with this program; if not, write to the Free Software Foundation, Inc.,
35 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
36 * http://www.gnu.org/copyleft/gpl.html
42 * @defgroup Globalsettings Global settings
46 * @cond file_level_code
47 * This is not a valid entry point, perform no further processing unless
48 * MEDIAWIKI is defined
50 if ( !defined( 'MEDIAWIKI' ) ) {
51 echo "This file is part of MediaWiki and is not a valid entry point\n";
58 * wgConf hold the site configuration.
59 * Not used for much in a default install.
62 $wgConf = new SiteConfiguration
;
65 * Registry of factory functions to create config objects:
66 * The 'main' key must be set, and the value should be a valid
71 'main' => 'GlobalVarConfig::newInstance'
75 * MediaWiki version number
78 $wgVersion = '1.28.0-alpha';
81 * Name of the site. It must be changed in LocalSettings.php
83 $wgSitename = 'MediaWiki';
86 * When the wiki is running behind a proxy and this is set to true, assumes that the proxy exposes
87 * the wiki on the standard ports (443 for https and 80 for http).
91 $wgAssumeProxiesUseDefaultProtocolPorts = true;
98 * $wgServer = 'http://example.com';
101 * This is usually detected correctly by MediaWiki. If MediaWiki detects the
102 * wrong server, it will redirect incorrectly after you save a page. In that
103 * case, set this variable to fix it.
105 * If you want to use protocol-relative URLs on your wiki, set this to a
106 * protocol-relative URL like '//example.com' and set $wgCanonicalServer
107 * to a fully qualified URL.
109 $wgServer = WebRequest
::detectServer();
112 * Canonical URL of the server, to use in IRC feeds and notification e-mails.
113 * Must be fully qualified, even if $wgServer is protocol-relative.
115 * Defaults to $wgServer, expanded to a fully qualified http:// URL if needed.
118 $wgCanonicalServer = false;
121 * Server name. This is automatically computed by parsing the bare
122 * hostname out of $wgCanonicalServer. It should not be customized.
125 $wgServerName = false;
127 /************************************************************************//**
128 * @name Script path settings
133 * The path we should point to.
134 * It might be a virtual path in case with use apache mod_rewrite for example.
136 * This *needs* to be set correctly.
138 * Other paths will be set to defaults based on it unless they are directly
139 * set in LocalSettings.php
141 $wgScriptPath = '/wiki';
144 * Whether to support URLs like index.php/Page_title These often break when PHP
145 * is set up in CGI mode. PATH_INFO *may* be correct if cgi.fix_pathinfo is set,
146 * but then again it may not; lighttpd converts incoming path data to lowercase
147 * on systems with case-insensitive filesystems, and there have been reports of
148 * problems on Apache as well.
150 * To be safe we'll continue to keep it off by default.
152 * Override this to false if $_SERVER['PATH_INFO'] contains unexpectedly
153 * incorrect garbage, or to true if it is really correct.
155 * The default $wgArticlePath will be set based on this value at runtime, but if
156 * you have customized it, having this incorrectly set to true can cause
157 * redirect loops when "pretty URLs" are used.
160 $wgUsePathInfo = ( strpos( PHP_SAPI
, 'cgi' ) === false ) &&
161 ( strpos( PHP_SAPI
, 'apache2filter' ) === false ) &&
162 ( strpos( PHP_SAPI
, 'isapi' ) === false );
165 * The extension to append to script names by default.
167 * Some hosting providers used PHP 4 for *.php files, and PHP 5 for *.php5.
168 * This variable was provided to support those providers.
171 * @deprecated since 1.25; support for '.php5' has been phased out of MediaWiki
172 * proper. Backward-compatibility can be maintained by configuring your web
173 * server to rewrite URLs. See RELEASE-NOTES for details.
175 $wgScriptExtension = '.php';
179 /************************************************************************//**
180 * @name URLs and file paths
182 * These various web and file path variables are set to their defaults
183 * in Setup.php if they are not explicitly set from LocalSettings.php.
185 * These will relatively rarely need to be set manually, unless you are
186 * splitting style sheets or images outside the main document root.
188 * In this section, a "path" is usually a host-relative URL, i.e. a URL without
189 * the host part, that starts with a slash. In most cases a full URL is also
190 * acceptable. A "directory" is a local file path.
192 * In both paths and directories, trailing slashes should not be included.
198 * The URL path to index.php.
200 * Defaults to "{$wgScriptPath}/index.php".
205 * The URL path to load.php.
207 * Defaults to "{$wgScriptPath}/load.php".
210 $wgLoadScript = false;
213 * The URL path of the skins directory.
214 * Defaults to "{$wgResourceBasePath}/skins".
217 $wgStylePath = false;
218 $wgStyleSheetPath = &$wgStylePath;
221 * The URL path of the skins directory. Should not point to an external domain.
222 * Defaults to "{$wgScriptPath}/skins".
225 $wgLocalStylePath = false;
228 * The URL path of the extensions directory.
229 * Defaults to "{$wgResourceBasePath}/extensions".
232 $wgExtensionAssetsPath = false;
235 * Filesystem extensions directory.
236 * Defaults to "{$IP}/extensions".
239 $wgExtensionDirectory = "{$IP}/extensions";
242 * Filesystem stylesheets directory.
243 * Defaults to "{$IP}/skins".
246 $wgStyleDirectory = "{$IP}/skins";
249 * The URL path for primary article page views. This path should contain $1,
250 * which is replaced by the article title.
252 * Defaults to "{$wgScript}/$1" or "{$wgScript}?title=$1",
253 * depending on $wgUsePathInfo.
255 $wgArticlePath = false;
258 * The URL path for the images directory.
259 * Defaults to "{$wgScriptPath}/images".
261 $wgUploadPath = false;
264 * The filesystem path of the images directory. Defaults to "{$IP}/images".
266 $wgUploadDirectory = false;
269 * Directory where the cached page will be saved.
270 * Defaults to "{$wgUploadDirectory}/cache".
272 $wgFileCacheDirectory = false;
275 * The URL path of the wiki logo. The logo size should be 135x135 pixels.
276 * Defaults to "$wgResourceBasePath/resources/assets/wiki.png".
281 * Array with URL paths to HD versions of the wiki logo. The scaled logo size
282 * should be under 135x155 pixels.
283 * Only 1.5x and 2x versions are supported.
288 * "1.5x" => "path/to/1.5x_version.png",
289 * "2x" => "path/to/2x_version.png"
298 * The URL path of the shortcut icon.
301 $wgFavicon = '/favicon.ico';
304 * The URL path of the icon for iPhone and iPod Touch web app bookmarks.
305 * Defaults to no icon.
308 $wgAppleTouchIcon = false;
311 * Value for the referrer policy meta tag.
312 * One of 'never', 'default', 'origin', 'always'. Setting it to false just
313 * prevents the meta tag from being output.
314 * See http://www.w3.org/TR/referrer-policy/ for details.
318 $wgReferrerPolicy = false;
321 * The local filesystem path to a temporary directory. This is not required to
324 * When this setting is set to false, its value will be set through a call
325 * to wfTempDir(). See that methods implementation for the actual detection
328 * Developers should use the global function wfTempDir() instead of this
332 * @note Default changed to false in MediaWiki 1.20.
334 $wgTmpDirectory = false;
337 * If set, this URL is added to the start of $wgUploadPath to form a complete
341 $wgUploadBaseUrl = '';
344 * To enable remote on-demand scaling, set this to the thumbnail base URL.
345 * Full thumbnail URL will be like $wgUploadStashScalerBaseUrl/e/e6/Foo.jpg/123px-Foo.jpg
346 * where 'e6' are the first two characters of the MD5 hash of the file name.
347 * If $wgUploadStashScalerBaseUrl is set to false, thumbs are rendered locally as needed.
350 $wgUploadStashScalerBaseUrl = false;
353 * To set 'pretty' URL paths for actions other than
354 * plain page views, add to this array.
357 * Set pretty URL for the edit action:
359 * 'edit' => "$wgScriptPath/edit/$1"
362 * There must be an appropriate script or rewrite rule in place to handle these
370 /************************************************************************//**
371 * @name Files and file uploads
376 * Uploads have to be specially set up to be secure
378 $wgEnableUploads = false;
381 * The maximum age of temporary (incomplete) uploaded files
383 $wgUploadStashMaxAge = 6 * 3600; // 6 hours
386 * Allows to move images and other media files
388 $wgAllowImageMoving = true;
391 * Enable deferred upload tasks that use the job queue.
392 * Only enable this if job runners are set up for both the
393 * 'AssembleUploadChunks' and 'PublishStashedFile' job types.
395 * @note If you use suhosin, this setting is incompatible with
396 * suhosin.session.encrypt.
398 $wgEnableAsyncUploads = false;
401 * These are additional characters that should be replaced with '-' in filenames
403 $wgIllegalFileChars = ":";
406 * What directory to place deleted uploads in.
407 * Defaults to "{$wgUploadDirectory}/deleted".
409 $wgDeletedDirectory = false;
412 * Set this to true if you use img_auth and want the user to see details on why access failed.
414 $wgImgAuthDetails = false;
417 * Map of relative URL directories to match to internal mwstore:// base storage paths.
418 * For img_auth.php requests, everything after "img_auth.php/" is checked to see
419 * if starts with any of the prefixes defined here. The prefixes should not overlap.
420 * The prefix that matches has a corresponding storage path, which the rest of the URL
421 * is assumed to be relative to. The file at that path (or a 404) is send to the client.
424 * $wgImgAuthUrlPathMap['/timeline/'] = 'mwstore://local-fs/timeline-render/';
425 * The above maps ".../img_auth.php/timeline/X" to "mwstore://local-fs/timeline-render/".
426 * The name "local-fs" should correspond by name to an entry in $wgFileBackends.
428 * @see $wgFileBackends
430 $wgImgAuthUrlPathMap = [];
433 * File repository structures
435 * $wgLocalFileRepo is a single repository structure, and $wgForeignFileRepos is
436 * an array of such structures. Each repository structure is an associative
437 * array of properties configuring the repository.
439 * Properties required for all repos:
440 * - class The class name for the repository. May come from the core or an extension.
441 * The core repository classes are FileRepo, LocalRepo, ForeignDBRepo.
442 * FSRepo is also supported for backwards compatibility.
444 * - name A unique name for the repository (but $wgLocalFileRepo should be 'local').
445 * The name should consist of alpha-numeric characters.
446 * - backend A file backend name (see $wgFileBackends).
448 * For most core repos:
449 * - zones Associative array of zone names that each map to an array with:
450 * container : backend container name the zone is in
451 * directory : root path within container for the zone
452 * url : base URL to the root of the zone
453 * urlsByExt : map of file extension types to base URLs
454 * (useful for using a different cache for videos)
455 * Zones default to using "<repo name>-<zone name>" as the container name
456 * and default to using the container root as the zone's root directory.
457 * Nesting of zone locations within other zones should be avoided.
458 * - url Public zone URL. The 'zones' settings take precedence.
459 * - hashLevels The number of directory levels for hash-based division of files
460 * - thumbScriptUrl The URL for thumb.php (optional, not recommended)
461 * - transformVia404 Whether to skip media file transformation on parse and rely on a 404
463 * - initialCapital Equivalent to $wgCapitalLinks (or $wgCapitalLinkOverrides[NS_FILE],
464 * determines whether filenames implicitly start with a capital letter.
465 * The current implementation may give incorrect description page links
466 * when the local $wgCapitalLinks and initialCapital are mismatched.
467 * - pathDisclosureProtection
468 * May be 'paranoid' to remove all parameters from error messages, 'none' to
469 * leave the paths in unchanged, or 'simple' to replace paths with
470 * placeholders. Default for LocalRepo is 'simple'.
471 * - fileMode This allows wikis to set the file mode when uploading/moving files. Default
473 * - directory The local filesystem directory where public files are stored. Not used for
475 * - thumbDir The base thumbnail directory. Defaults to "<directory>/thumb".
476 * - thumbUrl The base thumbnail URL. Defaults to "<url>/thumb".
477 * - isPrivate Set this if measures should always be taken to keep the files private.
478 * One should not trust this to assure that the files are not web readable;
479 * the server configuration should be done manually depending on the backend.
481 * These settings describe a foreign MediaWiki installation. They are optional, and will be ignored
482 * for local repositories:
483 * - descBaseUrl URL of image description pages, e.g. https://en.wikipedia.org/wiki/File:
484 * - scriptDirUrl URL of the MediaWiki installation, equivalent to $wgScriptPath, e.g.
485 * https://en.wikipedia.org/w
486 * - scriptExtension Script extension of the MediaWiki installation, equivalent to
487 * $wgScriptExtension, e.g. ".php5". Defaults to ".php".
489 * - articleUrl Equivalent to $wgArticlePath, e.g. https://en.wikipedia.org/wiki/$1
490 * - fetchDescription Fetch the text of the remote file description page. Equivalent to
491 * $wgFetchCommonsDescriptions.
492 * - abbrvThreshold File names over this size will use the short form of thumbnail names.
493 * Short thumbnail names only have the width, parameters, and the extension.
496 * - dbType, dbServer, dbUser, dbPassword, dbName, dbFlags
497 * equivalent to the corresponding member of $wgDBservers
498 * - tablePrefix Table prefix, the foreign wiki's $wgDBprefix
499 * - hasSharedCache True if the wiki's shared cache is accessible via the local $wgMemc
502 * - apibase Use for the foreign API's URL
503 * - apiThumbCacheExpiry How long to locally cache thumbs for
505 * If you leave $wgLocalFileRepo set to false, Setup will fill in appropriate values.
506 * Otherwise, set $wgLocalFileRepo to a repository structure as described above.
507 * If you set $wgUseInstantCommons to true, it will add an entry for Commons.
508 * If you set $wgForeignFileRepos to an array of repository structures, those will
509 * be searched after the local file repo.
510 * Otherwise, you will only have access to local media files.
512 * @see Setup.php for an example usage and default initialization.
514 $wgLocalFileRepo = false;
517 * @see $wgLocalFileRepo
519 $wgForeignFileRepos = [];
522 * Use Commons as a remote file repository. Essentially a wrapper, when this
523 * is enabled $wgForeignFileRepos will point at Commons with a set of default
526 $wgUseInstantCommons = false;
529 * Array of foreign file repo names (set in $wgForeignFileRepos above) that
530 * are allowable upload targets. These wikis must have some method of
531 * authentication (i.e. CentralAuth), and be CORS-enabled for this wiki.
532 * The string 'local' signifies the default local file repository.
535 * $wgForeignUploadTargets = [ 'shared' ];
537 $wgForeignUploadTargets = [ 'local' ];
540 * Configuration for file uploads using the embeddable upload dialog
541 * (https://www.mediawiki.org/wiki/Upload_dialog).
543 * This applies also to foreign uploads to this wiki (the configuration is loaded by remote wikis
544 * using the action=query&meta=siteinfo API).
546 * See below for documentation of each property. None of the properties may be omitted.
549 // Fields to make available in the dialog. `true` means that this field is visible, `false` means
550 // that it is hidden. The "Name" field can't be hidden. Note that you also have to add the
551 // matching replacement to the 'filepage' format key below to make use of these.
553 'description' => true,
555 'categories' => false,
557 // Suffix of localisation messages used to describe the license under which the uploaded file will
558 // be released. The same value may be set for both 'local' and 'foreign' uploads.
559 'licensemessages' => [
560 // The 'local' messages are used for local uploads on this wiki:
561 // * upload-form-label-own-work-message-generic-local
562 // * upload-form-label-not-own-work-message-generic-local
563 // * upload-form-label-not-own-work-local-generic-local
564 'local' => 'generic-local',
565 // The 'foreign' messages are used for cross-wiki uploads from other wikis to this wiki:
566 // * upload-form-label-own-work-message-generic-foreign
567 // * upload-form-label-not-own-work-message-generic-foreign
568 // * upload-form-label-not-own-work-local-generic-foreign
569 'foreign' => 'generic-foreign',
571 // Upload comments to use for 'local' and 'foreign' uploads. This can also be set to a single
572 // string value, in which case it is used for both kinds of uploads. Available replacements:
573 // * $HOST - domain name from which a cross-wiki upload originates
574 // * $PAGENAME - wiki page name from which an upload originates
579 // Format of the file page wikitext to be generated from the fields input by the user.
581 // Wrapper for the whole page. Available replacements:
582 // * $DESCRIPTION - file description, as input by the user (only if the 'description' field is
583 // enabled), wrapped as defined below in the 'description' key
584 // * $DATE - file creation date, as input by the user (only if the 'date' field is enabled)
585 // * $SOURCE - as defined below in the 'ownwork' key, may be extended in the future
586 // * $AUTHOR - linked user name, may be extended in the future
587 // * $LICENSE - as defined below in the 'license' key, may be extended in the future
588 // * $CATEGORIES - file categories wikitext, as input by the user (only if the 'categories'
589 // field is enabled), or if no input, as defined below in the 'uncategorized' key
590 'filepage' => '$DESCRIPTION',
591 // Wrapped for file description. Available replacements:
592 // * $LANGUAGE - source wiki's content language
593 // * $TEXT - input by the user
594 'description' => '$TEXT',
597 'uncategorized' => '',
602 * File backend structure configuration.
604 * This is an array of file backend configuration arrays.
605 * Each backend configuration has the following parameters:
606 * - 'name' : A unique name for the backend
607 * - 'class' : The file backend class to use
608 * - 'wikiId' : A unique string that identifies the wiki (container prefix)
609 * - 'lockManager' : The name of a lock manager (see $wgLockManagers)
611 * See FileBackend::__construct() for more details.
612 * Additional parameters are specific to the file backend class used.
613 * These settings should be global to all wikis when possible.
615 * There are two particularly important aspects about each backend:
616 * - a) Whether it is fully qualified or wiki-relative.
617 * By default, the paths of files are relative to the current wiki,
618 * which works via prefixing them with the current wiki ID when accessed.
619 * Setting 'wikiId' forces the backend to be fully qualified by prefixing
620 * all paths with the specified value instead. This can be useful if
621 * multiple wikis need to share the same data. Note that 'name' is *not*
622 * part of any prefix and thus should not be relied upon for namespacing.
623 * - b) Whether it is only defined for some wikis or is defined on all
624 * wikis in the wiki farm. Defining a backend globally is useful
625 * if multiple wikis need to share the same data.
626 * One should be aware of these aspects when configuring a backend for use with
627 * any basic feature or plugin. For example, suppose an extension stores data for
628 * different wikis in different directories and sometimes needs to access data from
629 * a foreign wiki's directory in order to render a page on given wiki. The extension
630 * would need a fully qualified backend that is defined on all wikis in the wiki farm.
632 $wgFileBackends = [];
635 * Array of configuration arrays for each lock manager.
636 * Each backend configuration has the following parameters:
637 * - 'name' : A unique name for the lock manager
638 * - 'class' : The lock manger class to use
640 * See LockManager::__construct() for more details.
641 * Additional parameters are specific to the lock manager class used.
642 * These settings should be global to all wikis.
644 $wgLockManagers = [];
647 * Show Exif data, on by default if available.
648 * Requires PHP's Exif extension: http://www.php.net/manual/en/ref.exif.php
650 * @note FOR WINDOWS USERS:
651 * To enable Exif functions, add the following line to the "Windows
652 * extensions" section of php.ini:
654 * extension=extensions/php_exif.dll
657 $wgShowEXIF = function_exists( 'exif_read_data' );
660 * If to automatically update the img_metadata field
661 * if the metadata field is outdated but compatible with the current version.
664 $wgUpdateCompatibleMetadata = false;
667 * If you operate multiple wikis, you can define a shared upload path here.
668 * Uploads to this wiki will NOT be put there - they will be put into
669 * $wgUploadDirectory.
670 * If $wgUseSharedUploads is set, the wiki will look in the shared repository if
671 * no file of the given name is found in the local repository (for [[File:..]],
672 * [[Media:..]] links). Thumbnails will also be looked for and generated in this
675 * Note that these configuration settings can now be defined on a per-
676 * repository basis for an arbitrary number of file repositories, using the
677 * $wgForeignFileRepos variable.
679 $wgUseSharedUploads = false;
682 * Full path on the web server where shared uploads can be found
684 $wgSharedUploadPath = "http://commons.wikimedia.org/shared/images";
687 * Fetch commons image description pages and display them on the local wiki?
689 $wgFetchCommonsDescriptions = false;
692 * Path on the file system where shared uploads can be found.
694 $wgSharedUploadDirectory = "/var/www/wiki3/images";
697 * DB name with metadata about shared directory.
698 * Set this to false if the uploads do not come from a wiki.
700 $wgSharedUploadDBname = false;
703 * Optional table prefix used in database.
705 $wgSharedUploadDBprefix = '';
708 * Cache shared metadata in memcached.
709 * Don't do this if the commons wiki is in a different memcached domain
711 $wgCacheSharedUploads = true;
714 * Allow for upload to be copied from an URL.
715 * The timeout for copy uploads is set by $wgCopyUploadTimeout.
716 * You have to assign the user right 'upload_by_url' to a user group, to use this.
718 $wgAllowCopyUploads = false;
721 * A list of domains copy uploads can come from
725 $wgCopyUploadsDomains = [];
728 * Enable copy uploads from Special:Upload. $wgAllowCopyUploads must also be
729 * true. If $wgAllowCopyUploads is true, but this is false, you will only be
730 * able to perform copy uploads from the API or extensions (e.g. UploadWizard).
732 $wgCopyUploadsFromSpecialUpload = false;
735 * Proxy to use for copy upload requests.
738 $wgCopyUploadProxy = false;
741 * Different timeout for upload by url
742 * This could be useful since when fetching large files, you may want a
743 * timeout longer than the default $wgHTTPTimeout. False means fallback
748 $wgCopyUploadTimeout = false;
751 * Max size for uploads, in bytes. If not set to an array, applies to all
752 * uploads. If set to an array, per upload type maximums can be set, using the
753 * file and url keys. If the * key is set this value will be used as maximum
754 * for non-specified types.
758 * $wgMaxUploadSize = [
760 * 'url' => 500 * 1024,
763 * Sets the maximum for all uploads to 250 kB except for upload-by-url, which
764 * will have a maximum of 500 kB.
766 $wgMaxUploadSize = 1024 * 1024 * 100; # 100MB
769 * Minimum upload chunk size, in bytes. When using chunked upload, non-final
770 * chunks smaller than this will be rejected. May be reduced based on the
771 * 'upload_max_filesize' or 'post_max_size' PHP settings.
774 $wgMinUploadChunkSize = 1024; # 1KB
777 * Point the upload navigation link to an external URL
778 * Useful if you want to use a shared repository by default
779 * without disabling local uploads (use $wgEnableUploads = false for that).
783 * $wgUploadNavigationUrl = 'https://commons.wikimedia.org/wiki/Special:Upload';
786 $wgUploadNavigationUrl = false;
789 * Point the upload link for missing files to an external URL, as with
790 * $wgUploadNavigationUrl. The URL will get "(?|&)wpDestFile=<filename>"
791 * appended to it as appropriate.
793 $wgUploadMissingFileUrl = false;
796 * Give a path here to use thumb.php for thumbnail generation on client
797 * request, instead of generating them on render and outputting a static URL.
798 * This is necessary if some of your apache servers don't have read/write
799 * access to the thumbnail path.
803 * $wgThumbnailScriptPath = "{$wgScriptPath}/thumb.php";
806 $wgThumbnailScriptPath = false;
809 * @see $wgThumbnailScriptPath
811 $wgSharedThumbnailScriptPath = false;
814 * Set this to false if you do not want MediaWiki to divide your images
815 * directory into many subdirectories, for improved performance.
817 * It's almost always good to leave this enabled. In previous versions of
818 * MediaWiki, some users set this to false to allow images to be added to the
819 * wiki by simply copying them into $wgUploadDirectory and then running
820 * maintenance/rebuildImages.php to register them in the database. This is no
821 * longer recommended, use maintenance/importImages.php instead.
823 * @note That this variable may be ignored if $wgLocalFileRepo is set.
824 * @todo Deprecate the setting and ultimately remove it from Core.
826 $wgHashedUploadDirectory = true;
829 * Set the following to false especially if you have a set of files that need to
830 * be accessible by all wikis, and you do not want to use the hash (path/a/aa/)
833 $wgHashedSharedUploadDirectory = true;
836 * Base URL for a repository wiki. Leave this blank if uploads are just stored
837 * in a shared directory and not meant to be accessible through a separate wiki.
838 * Otherwise the image description pages on the local wiki will link to the
839 * image description page on this wiki.
841 * Please specify the namespace, as in the example below.
843 $wgRepositoryBaseUrl = "https://commons.wikimedia.org/wiki/File:";
846 * This is the list of preferred extensions for uploading files. Uploading files
847 * with extensions not in this list will trigger a warning.
849 * @warning If you add any OpenOffice or Microsoft Office file formats here,
850 * such as odt or doc, and untrusted users are allowed to upload files, then
851 * your wiki will be vulnerable to cross-site request forgery (CSRF).
853 $wgFileExtensions = [ 'png', 'gif', 'jpg', 'jpeg', 'webp' ];
856 * Files with these extensions will never be allowed as uploads.
857 * An array of file extensions to blacklist. You should append to this array
858 * if you want to blacklist additional files.
861 # HTML may contain cookie-stealing JavaScript and web bugs
862 'html', 'htm', 'js', 'jsb', 'mhtml', 'mht', 'xhtml', 'xht',
863 # PHP scripts may execute arbitrary code on the server
864 'php', 'phtml', 'php3', 'php4', 'php5', 'phps',
865 # Other types that may be interpreted by some servers
866 'shtml', 'jhtml', 'pl', 'py', 'cgi',
867 # May contain harmful executables for Windows victims
868 'exe', 'scr', 'dll', 'msi', 'vbs', 'bat', 'com', 'pif', 'cmd', 'vxd', 'cpl' ];
871 * Files with these MIME types will never be allowed as uploads
872 * if $wgVerifyMimeType is enabled.
874 $wgMimeTypeBlacklist = [
875 # HTML may contain cookie-stealing JavaScript and web bugs
876 'text/html', 'text/javascript', 'text/x-javascript', 'application/x-shellscript',
877 # PHP scripts may execute arbitrary code on the server
878 'application/x-php', 'text/x-php',
879 # Other types that may be interpreted by some servers
880 'text/x-python', 'text/x-perl', 'text/x-bash', 'text/x-sh', 'text/x-csh',
881 # Client-side hazards on Internet Explorer
882 'text/scriptlet', 'application/x-msdownload',
883 # Windows metafile, client-side vulnerability on some systems
884 'application/x-msmetafile',
888 * Allow Java archive uploads.
889 * This is not recommended for public wikis since a maliciously-constructed
890 * applet running on the same domain as the wiki can steal the user's cookies.
892 $wgAllowJavaUploads = false;
895 * This is a flag to determine whether or not to check file extensions on upload.
897 * @warning Setting this to false is insecure for public wikis.
899 $wgCheckFileExtensions = true;
902 * If this is turned off, users may override the warning for files not covered
903 * by $wgFileExtensions.
905 * @warning Setting this to false is insecure for public wikis.
907 $wgStrictFileExtensions = true;
910 * Setting this to true will disable the upload system's checks for HTML/JavaScript.
912 * @warning THIS IS VERY DANGEROUS on a publicly editable site, so USE
913 * $wgGroupPermissions TO RESTRICT UPLOADING to only those that you trust
915 $wgDisableUploadScriptChecks = false;
918 * Warn if uploaded files are larger than this (in bytes), or false to disable
920 $wgUploadSizeWarning = false;
923 * list of trusted media-types and MIME types.
924 * Use the MEDIATYPE_xxx constants to represent media types.
925 * This list is used by File::isSafeFile
927 * Types not listed here will have a warning about unsafe content
928 * displayed on the images description page. It would also be possible
929 * to use this for further restrictions, like disabling direct
930 * [[media:...]] links for non-trusted formats.
932 $wgTrustedMediaFormats = [
933 MEDIATYPE_BITMAP
, // all bitmap formats
934 MEDIATYPE_AUDIO
, // all audio formats
935 MEDIATYPE_VIDEO
, // all plain video formats
936 "image/svg+xml", // svg (only needed if inline rendering of svg is not supported)
937 "application/pdf", // PDF files
938 # "application/x-shockwave-flash", //flash/shockwave movie
942 * Plugins for media file type handling.
943 * Each entry in the array maps a MIME type to a class name
946 'image/jpeg' => 'JpegHandler',
947 'image/png' => 'PNGHandler',
948 'image/gif' => 'GIFHandler',
949 'image/tiff' => 'TiffHandler',
950 'image/webp' => 'WebPHandler',
951 'image/x-ms-bmp' => 'BmpHandler',
952 'image/x-bmp' => 'BmpHandler',
953 'image/x-xcf' => 'XCFHandler',
954 'image/svg+xml' => 'SvgHandler', // official
955 'image/svg' => 'SvgHandler', // compat
956 'image/vnd.djvu' => 'DjVuHandler', // official
957 'image/x.djvu' => 'DjVuHandler', // compat
958 'image/x-djvu' => 'DjVuHandler', // compat
962 * Plugins for page content model handling.
963 * Each entry in the array maps a model id to a class name or callback
964 * that creates an instance of the appropriate ContentHandler subclass.
968 $wgContentHandlers = [
970 CONTENT_MODEL_WIKITEXT
=> 'WikitextContentHandler',
971 // dumb version, no syntax highlighting
972 CONTENT_MODEL_JAVASCRIPT
=> 'JavaScriptContentHandler',
973 // simple implementation, for use by extensions, etc.
974 CONTENT_MODEL_JSON
=> 'JsonContentHandler',
975 // dumb version, no syntax highlighting
976 CONTENT_MODEL_CSS
=> 'CssContentHandler',
977 // plain text, for use by extensions, etc.
978 CONTENT_MODEL_TEXT
=> 'TextContentHandler',
982 * Whether to enable server-side image thumbnailing. If false, images will
983 * always be sent to the client in full resolution, with appropriate width= and
984 * height= attributes on the <img> tag for the client to do its own scaling.
986 $wgUseImageResize = true;
989 * Resizing can be done using PHP's internal image libraries or using
990 * ImageMagick or another third-party converter, e.g. GraphicMagick.
991 * These support more file formats than PHP, which only supports PNG,
992 * GIF, JPG, XBM and WBMP.
994 * Use Image Magick instead of PHP builtin functions.
996 $wgUseImageMagick = false;
999 * The convert command shipped with ImageMagick
1001 $wgImageMagickConvertCommand = '/usr/bin/convert';
1004 * Array of max pixel areas for interlacing per MIME type
1007 $wgMaxInterlacingAreas = [];
1010 * Sharpening parameter to ImageMagick
1012 $wgSharpenParameter = '0x0.4';
1015 * Reduction in linear dimensions below which sharpening will be enabled
1017 $wgSharpenReductionThreshold = 0.85;
1020 * Temporary directory used for ImageMagick. The directory must exist. Leave
1021 * this set to false to let ImageMagick decide for itself.
1023 $wgImageMagickTempDir = false;
1026 * Use another resizing converter, e.g. GraphicMagick
1027 * %s will be replaced with the source path, %d with the destination
1028 * %w and %h will be replaced with the width and height.
1030 * @par Example for GraphicMagick:
1032 * $wgCustomConvertCommand = "gm convert %s -resize %wx%h %d"
1035 * Leave as false to skip this.
1037 $wgCustomConvertCommand = false;
1040 * used for lossless jpeg rotation
1044 $wgJpegTran = '/usr/bin/jpegtran';
1047 * At default setting of 'yuv420', JPEG thumbnails will use 4:2:0 chroma
1048 * subsampling to reduce file size, at the cost of possible color fringing
1051 * See https://en.wikipedia.org/wiki/Chroma_subsampling
1054 * false - use scaling system's default (same as pre-1.27 behavior)
1055 * 'yuv444' - luma and chroma at same resolution
1056 * 'yuv422' - chroma at 1/2 resolution horizontally, full vertically
1057 * 'yuv420' - chroma at 1/2 resolution in both dimensions
1059 * This setting is currently supported only for the ImageMagick backend;
1060 * others may default to 4:2:0 or 4:4:4 or maintaining the source file's
1061 * sampling in the thumbnail.
1065 $wgJpegPixelFormat = 'yuv420';
1068 * Some tests and extensions use exiv2 to manipulate the Exif metadata in some
1071 $wgExiv2Command = '/usr/bin/exiv2';
1074 * Path to exiftool binary. Used for lossless ICC profile swapping.
1078 $wgExiftool = '/usr/bin/exiftool';
1081 * Scalable Vector Graphics (SVG) may be uploaded as images.
1082 * Since SVG support is not yet standard in browsers, it is
1083 * necessary to rasterize SVGs to PNG as a fallback format.
1085 * An external program is required to perform this conversion.
1086 * If set to an array, the first item is a PHP callable and any further items
1087 * are passed as parameters after $srcPath, $dstPath, $width, $height
1089 $wgSVGConverters = [
1091 '$path/convert -background "#ffffff00" -thumbnail $widthx$height\! $input PNG:$output',
1092 'sodipodi' => '$path/sodipodi -z -w $width -f $input -e $output',
1093 'inkscape' => '$path/inkscape -z -w $width -f $input -e $output',
1094 'batik' => 'java -Djava.awt.headless=true -jar $path/batik-rasterizer.jar -w $width -d '
1096 'rsvg' => '$path/rsvg-convert -w $width -h $height -o $output $input',
1097 'imgserv' => '$path/imgserv-wrapper -i svg -o png -w$width $input $output',
1098 'ImagickExt' => [ 'SvgHandler::rasterizeImagickExt' ],
1102 * Pick a converter defined in $wgSVGConverters
1104 $wgSVGConverter = 'ImageMagick';
1107 * If not in the executable PATH, specify the SVG converter path.
1109 $wgSVGConverterPath = '';
1112 * Don't scale a SVG larger than this
1114 $wgSVGMaxSize = 5120;
1117 * Don't read SVG metadata beyond this point.
1118 * Default is 1024*256 bytes
1120 $wgSVGMetadataCutoff = 262144;
1123 * Disallow <title> element in SVG files.
1125 * MediaWiki will reject HTMLesque tags in uploaded files due to idiotic
1126 * browsers which can not perform basic stuff like MIME detection and which are
1127 * vulnerable to further idiots uploading crap files as images.
1129 * When this directive is on, "<title>" will be allowed in files with an
1130 * "image/svg+xml" MIME type. You should leave this disabled if your web server
1131 * is misconfigured and doesn't send appropriate MIME types for SVG images.
1133 $wgAllowTitlesInSVG = false;
1136 * The maximum number of pixels a source image can have if it is to be scaled
1137 * down by a scaler that requires the full source image to be decompressed
1138 * and stored in decompressed form, before the thumbnail is generated.
1140 * This provides a limit on memory usage for the decompression side of the
1141 * image scaler. The limit is used when scaling PNGs with any of the
1142 * built-in image scalers, such as ImageMagick or GD. It is ignored for
1143 * JPEGs with ImageMagick, and when using the VipsScaler extension.
1145 * The default is 50 MB if decompressed to RGBA form, which corresponds to
1146 * 12.5 million pixels or 3500x3500.
1148 $wgMaxImageArea = 1.25e7
;
1151 * Force thumbnailing of animated GIFs above this size to a single
1152 * frame instead of an animated thumbnail. As of MW 1.17 this limit
1153 * is checked against the total size of all frames in the animation.
1154 * It probably makes sense to keep this equal to $wgMaxImageArea.
1156 $wgMaxAnimatedGifArea = 1.25e7
;
1159 * Browsers don't support TIFF inline generally...
1160 * For inline display, we need to convert to PNG or JPEG.
1161 * Note scaling should work with ImageMagick, but may not with GD scaling.
1165 * // PNG is lossless, but inefficient for photos
1166 * $wgTiffThumbnailType = [ 'png', 'image/png' ];
1167 * // JPEG is good for photos, but has no transparency support. Bad for diagrams.
1168 * $wgTiffThumbnailType = [ 'jpg', 'image/jpeg' ];
1171 $wgTiffThumbnailType = false;
1174 * If rendered thumbnail files are older than this timestamp, they
1175 * will be rerendered on demand as if the file didn't already exist.
1176 * Update if there is some need to force thumbs and SVG rasterizations
1177 * to rerender, such as fixes to rendering bugs.
1179 $wgThumbnailEpoch = '20030516000000';
1182 * Certain operations are avoided if there were too many recent failures,
1183 * for example, thumbnail generation. Bump this value to invalidate all
1184 * memory of failed operations and thus allow further attempts to resume.
1185 * This is useful when a cause for the failures has been found and fixed.
1187 $wgAttemptFailureEpoch = 1;
1190 * If set, inline scaled images will still produce "<img>" tags ready for
1191 * output instead of showing an error message.
1193 * This may be useful if errors are transitory, especially if the site
1194 * is configured to automatically render thumbnails on request.
1196 * On the other hand, it may obscure error conditions from debugging.
1197 * Enable the debug log or the 'thumbnail' log group to make sure errors
1198 * are logged to a file for review.
1200 $wgIgnoreImageErrors = false;
1203 * Allow thumbnail rendering on page view. If this is false, a valid
1204 * thumbnail URL is still output, but no file will be created at
1205 * the target location. This may save some time if you have a
1206 * thumb.php or 404 handler set up which is faster than the regular
1209 $wgGenerateThumbnailOnParse = true;
1212 * Show thumbnails for old images on the image description page
1214 $wgShowArchiveThumbnails = true;
1217 * If set to true, images that contain certain the exif orientation tag will
1218 * be rotated accordingly. If set to null, try to auto-detect whether a scaler
1219 * is available that can rotate.
1221 $wgEnableAutoRotation = null;
1224 * Internal name of virus scanner. This serves as a key to the
1225 * $wgAntivirusSetup array. Set this to NULL to disable virus scanning. If not
1226 * null, every file uploaded will be scanned for viruses.
1228 $wgAntivirus = null;
1231 * Configuration for different virus scanners. This an associative array of
1232 * associative arrays. It contains one setup array per known scanner type.
1233 * The entry is selected by $wgAntivirus, i.e.
1234 * valid values for $wgAntivirus are the keys defined in this array.
1236 * The configuration array for each scanner contains the following keys:
1237 * "command", "codemap", "messagepattern":
1239 * "command" is the full command to call the virus scanner - %f will be
1240 * replaced with the name of the file to scan. If not present, the filename
1241 * will be appended to the command. Note that this must be overwritten if the
1242 * scanner is not in the system path; in that case, please set
1243 * $wgAntivirusSetup[$wgAntivirus]['command'] to the desired command with full
1246 * "codemap" is a mapping of exit code to return codes of the detectVirus
1247 * function in SpecialUpload.
1248 * - An exit code mapped to AV_SCAN_FAILED causes the function to consider
1249 * the scan to be failed. This will pass the file if $wgAntivirusRequired
1251 * - An exit code mapped to AV_SCAN_ABORTED causes the function to consider
1252 * the file to have an unsupported format, which is probably immune to
1253 * viruses. This causes the file to pass.
1254 * - An exit code mapped to AV_NO_VIRUS will cause the file to pass, meaning
1255 * no virus was found.
1256 * - All other codes (like AV_VIRUS_FOUND) will cause the function to report
1258 * - You may use "*" as a key in the array to catch all exit codes not mapped otherwise.
1260 * "messagepattern" is a perl regular expression to extract the meaningful part of the scanners
1261 * output. The relevant part should be matched as group one (\1).
1262 * If not defined or the pattern does not match, the full message is shown to the user.
1264 $wgAntivirusSetup = [
1268 'command' => 'clamscan --no-summary ',
1270 "0" => AV_NO_VIRUS
, # no virus
1271 "1" => AV_VIRUS_FOUND
, # virus found
1272 "52" => AV_SCAN_ABORTED
, # unsupported file format (probably immune)
1273 "*" => AV_SCAN_FAILED
, # else scan failed
1275 'messagepattern' => '/.*?:(.*)/sim',
1280 * Determines if a failed virus scan (AV_SCAN_FAILED) will cause the file to be rejected.
1282 $wgAntivirusRequired = true;
1285 * Determines if the MIME type of uploaded files should be checked
1287 $wgVerifyMimeType = true;
1290 * Sets the MIME type definition file to use by MimeMagic.php.
1291 * Set to null, to use built-in defaults only.
1292 * example: $wgMimeTypeFile = '/etc/mime.types';
1294 $wgMimeTypeFile = 'includes/mime.types';
1297 * Sets the MIME type info file to use by MimeMagic.php.
1298 * Set to null, to use built-in defaults only.
1300 $wgMimeInfoFile = 'includes/mime.info';
1303 * Sets an external MIME detector program. The command must print only
1304 * the MIME type to standard output.
1305 * The name of the file to process will be appended to the command given here.
1306 * If not set or NULL, PHP's fileinfo extension will be used if available.
1310 * #$wgMimeDetectorCommand = "file -bi"; # use external MIME detector (Linux)
1313 $wgMimeDetectorCommand = null;
1316 * Switch for trivial MIME detection. Used by thumb.php to disable all fancy
1317 * things, because only a few types of images are needed and file extensions
1320 $wgTrivialMimeDetection = false;
1323 * Additional XML types we can allow via MIME-detection.
1324 * array = [ 'rootElement' => 'associatedMimeType' ]
1327 'http://www.w3.org/2000/svg:svg' => 'image/svg+xml',
1328 'svg' => 'image/svg+xml',
1329 'http://www.lysator.liu.se/~alla/dia/:diagram' => 'application/x-dia-diagram',
1330 'http://www.w3.org/1999/xhtml:html' => 'text/html', // application/xhtml+xml?
1331 'html' => 'text/html', // application/xhtml+xml?
1335 * Limit images on image description pages to a user-selectable limit. In order
1336 * to reduce disk usage, limits can only be selected from a list.
1337 * The user preference is saved as an array offset in the database, by default
1338 * the offset is set with $wgDefaultUserOptions['imagesize']. Make sure you
1339 * change it if you alter the array (see bug 8858).
1340 * This is the list of settings the user can choose from:
1351 * Adjust thumbnails on image pages according to a user setting. In order to
1352 * reduce disk usage, the values can only be selected from a list. This is the
1353 * list of settings the user can choose from:
1365 * When defined, is an array of image widths used as buckets for thumbnail generation.
1366 * The goal is to save resources by generating thumbnails based on reference buckets instead of
1367 * always using the original. This will incur a speed gain but cause a quality loss.
1369 * The buckets generation is chained, with each bucket generated based on the above bucket
1370 * when possible. File handlers have to opt into using that feature. For now only BitmapHandler
1373 $wgThumbnailBuckets = null;
1376 * When using thumbnail buckets as defined above, this sets the minimum distance to the bucket
1377 * above the requested size. The distance represents how many extra pixels of width the bucket
1378 * needs in order to be used as the reference for a given thumbnail. For example, with the
1379 * following buckets:
1381 * $wgThumbnailBuckets = [ 128, 256, 512 ];
1383 * and a distance of 50:
1385 * $wgThumbnailMinimumBucketDistance = 50;
1387 * If we want to render a thumbnail of width 220px, the 512px bucket will be used,
1388 * because 220 + 50 = 270 and the closest bucket bigger than 270px is 512.
1390 $wgThumbnailMinimumBucketDistance = 50;
1393 * When defined, is an array of thumbnail widths to be rendered at upload time. The idea is to
1394 * prerender common thumbnail sizes, in order to avoid the necessity to render them on demand, which
1395 * has a performance impact for the first client to view a certain size.
1397 * This obviously means that more disk space is needed per upload upfront.
1402 $wgUploadThumbnailRenderMap = [];
1405 * The method through which the thumbnails will be prerendered for the entries in
1406 * $wgUploadThumbnailRenderMap
1408 * The method can be either "http" or "jobqueue". The former uses an http request to hit the
1410 * This method only works if thumbnails are configured to be rendered by a 404 handler. The latter
1411 * option uses the job queue to render the thumbnail.
1415 $wgUploadThumbnailRenderMethod = 'jobqueue';
1418 * When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom Host HTTP header.
1422 $wgUploadThumbnailRenderHttpCustomHost = false;
1425 * When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom domain to send the
1430 $wgUploadThumbnailRenderHttpCustomDomain = false;
1433 * When this variable is true and JPGs use the sRGB ICC profile, swaps it for the more lightweight
1434 * (and free) TinyRGB profile when generating thumbnails.
1438 $wgUseTinyRGBForJPGThumbnails = false;
1441 * Default parameters for the "<gallery>" tag
1443 $wgGalleryOptions = [
1444 'imagesPerRow' => 0, // Default number of images per-row in the gallery. 0 -> Adapt to screensize
1445 'imageWidth' => 120, // Width of the cells containing images in galleries (in "px")
1446 'imageHeight' => 120, // Height of the cells containing images in galleries (in "px")
1447 'captionLength' => 25, // Length to truncate filename to in caption when using "showfilename"
1448 'showBytes' => true, // Show the filesize in bytes in categories
1449 'mode' => 'traditional',
1453 * Adjust width of upright images when parameter 'upright' is used
1454 * This allows a nicer look for upright images without the need to fix the width
1455 * by hardcoded px in wiki sourcecode.
1457 $wgThumbUpright = 0.75;
1460 * Default value for chmoding of new directories.
1462 $wgDirectoryMode = 0777;
1465 * Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities.
1467 * This means a 320x240 use of an image on the wiki will also generate 480x360 and 640x480
1468 * thumbnails, output via the srcset attribute.
1470 * On older browsers, a JavaScript polyfill switches the appropriate images in after loading
1471 * the original low-resolution versions depending on the reported window.devicePixelRatio.
1472 * The polyfill can be found in the jquery.hidpi module.
1474 $wgResponsiveImages = true;
1477 * @name DJVU settings
1482 * Path of the djvudump executable
1483 * Enable this and $wgDjvuRenderer to enable djvu rendering
1484 * example: $wgDjvuDump = 'djvudump';
1489 * Path of the ddjvu DJVU renderer
1490 * Enable this and $wgDjvuDump to enable djvu rendering
1491 * example: $wgDjvuRenderer = 'ddjvu';
1493 $wgDjvuRenderer = null;
1496 * Path of the djvutxt DJVU text extraction utility
1497 * Enable this and $wgDjvuDump to enable text layer extraction from djvu files
1498 * example: $wgDjvuTxt = 'djvutxt';
1503 * Path of the djvutoxml executable
1504 * This works like djvudump except much, much slower as of version 3.5.
1506 * For now we recommend you use djvudump instead. The djvuxml output is
1507 * probably more stable, so we'll switch back to it as soon as they fix
1508 * the efficiency problem.
1509 * http://sourceforge.net/tracker/index.php?func=detail&aid=1704049&group_id=32953&atid=406583
1513 * $wgDjvuToXML = 'djvutoxml';
1516 $wgDjvuToXML = null;
1519 * Shell command for the DJVU post processor
1520 * Default: pnmtojpeg, since ddjvu generates ppm output
1521 * Set this to false to output the ppm file directly.
1523 $wgDjvuPostProcessor = 'pnmtojpeg';
1526 * File extension for the DJVU post processor output
1528 $wgDjvuOutputExtension = 'jpg';
1530 /** @} */ # end of DJvu }
1532 /** @} */ # end of file uploads }
1534 /************************************************************************//**
1535 * @name Email settings
1540 * Site admin email address.
1542 * Defaults to "wikiadmin@$wgServerName".
1544 $wgEmergencyContact = false;
1547 * Sender email address for e-mail notifications.
1549 * The address we use as sender when a user requests a password reminder.
1551 * Defaults to "apache@$wgServerName".
1553 $wgPasswordSender = false;
1556 * Sender name for e-mail notifications.
1558 * @deprecated since 1.23; use the system message 'emailsender' instead.
1560 $wgPasswordSenderName = 'MediaWiki Mail';
1563 * Reply-To address for e-mail notifications.
1565 * Defaults to $wgPasswordSender.
1567 $wgNoReplyAddress = false;
1570 * Set to true to enable the e-mail basic features:
1571 * Password reminders, etc. If sending e-mail on your
1572 * server doesn't work, you might want to disable this.
1574 $wgEnableEmail = true;
1577 * Set to true to enable user-to-user e-mail.
1578 * This can potentially be abused, as it's hard to track.
1580 $wgEnableUserEmail = true;
1583 * Set to true to put the sending user's email in a Reply-To header
1584 * instead of From. ($wgEmergencyContact will be used as From.)
1586 * Some mailers (eg SMTP) set the SMTP envelope sender to the From value,
1587 * which can cause problems with SPF validation and leak recipient addresses
1588 * when bounces are sent to the sender.
1590 $wgUserEmailUseReplyTo = false;
1593 * Minimum time, in hours, which must elapse between password reminder
1594 * emails for a given account. This is to prevent abuse by mail flooding.
1596 $wgPasswordReminderResendTime = 24;
1599 * The time, in seconds, when an emailed temporary password expires.
1601 $wgNewPasswordExpiry = 3600 * 24 * 7;
1604 * The time, in seconds, when an email confirmation email expires
1606 $wgUserEmailConfirmationTokenExpiry = 7 * 24 * 60 * 60;
1609 * The number of days that a user's password is good for. After this number of days, the
1610 * user will be asked to reset their password. Set to false to disable password expiration.
1612 $wgPasswordExpirationDays = false;
1615 * If a user's password is expired, the number of seconds when they can still login,
1616 * and cancel their password change, but are sent to the password change form on each login.
1618 $wgPasswordExpireGrace = 3600 * 24 * 7; // 7 days
1623 * For using a direct (authenticated) SMTP server connection.
1624 * Default to false or fill an array :
1628 * 'host' => 'SMTP domain',
1629 * 'IDHost' => 'domain for MessageID',
1631 * 'auth' => [true|false],
1632 * 'username' => [SMTP username],
1633 * 'password' => [SMTP password],
1640 * Additional email parameters, will be passed as the last argument to mail() call.
1642 $wgAdditionalMailParams = null;
1645 * For parts of the system that have been updated to provide HTML email content, send
1646 * both text and HTML parts as the body of the email
1648 $wgAllowHTMLEmail = false;
1651 * True: from page editor if s/he opted-in. False: Enotif mails appear to come
1652 * from $wgEmergencyContact
1654 $wgEnotifFromEditor = false;
1656 // TODO move UPO to preferences probably ?
1657 # If set to true, users get a corresponding option in their preferences and can choose to
1658 # enable or disable at their discretion
1659 # If set to false, the corresponding input form on the user preference page is suppressed
1660 # It call this to be a "user-preferences-option (UPO)"
1663 * Require email authentication before sending mail to an email address.
1664 * This is highly recommended. It prevents MediaWiki from being used as an open
1667 $wgEmailAuthentication = true;
1670 * Allow users to enable email notification ("enotif") on watchlist changes.
1672 $wgEnotifWatchlist = false;
1675 * Allow users to enable email notification ("enotif") when someone edits their
1678 $wgEnotifUserTalk = false;
1681 * Set the Reply-to address in notifications to the editor's address, if user
1682 * allowed this in the preferences.
1684 $wgEnotifRevealEditorAddress = false;
1687 * Send notification mails on minor edits to watchlist pages. This is enabled
1688 * by default. User talk notifications are affected by this, $wgEnotifUserTalk, and
1689 * the nominornewtalk user right.
1691 $wgEnotifMinorEdits = true;
1694 * Send a generic mail instead of a personalised mail for each user. This
1695 * always uses UTC as the time zone, and doesn't include the username.
1697 * For pages with many users watching, this can significantly reduce mail load.
1698 * Has no effect when using sendmail rather than SMTP.
1700 $wgEnotifImpersonal = false;
1703 * Maximum number of users to mail at once when using impersonal mail. Should
1704 * match the limit on your mail server.
1706 $wgEnotifMaxRecips = 500;
1709 * Use real name instead of username in e-mail "from" field.
1711 $wgEnotifUseRealName = false;
1714 * Array of usernames who will be sent a notification email for every change
1715 * which occurs on a wiki. Users will not be notified of their own changes.
1717 $wgUsersNotifiedOnAllChanges = [];
1719 /** @} */ # end of email settings
1721 /************************************************************************//**
1722 * @name Database settings
1727 * Database host name or IP address
1729 $wgDBserver = 'localhost';
1732 * Database port number (for PostgreSQL and Microsoft SQL Server).
1737 * Name of the database
1739 $wgDBname = 'my_wiki';
1744 $wgDBuser = 'wikiuser';
1747 * Database user's password
1754 $wgDBtype = 'mysql';
1757 * Whether to use SSL in DB connection.
1759 * This setting is only used $wgLBFactoryConf['class'] is set to
1760 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
1761 * the DBO_SSL flag must be set in the 'flags' option of the database
1762 * connection to achieve the same functionality.
1767 * Whether to use compression in DB connection.
1769 * This setting is only used $wgLBFactoryConf['class'] is set to
1770 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
1771 * the DBO_COMPRESS flag must be set in the 'flags' option of the database
1772 * connection to achieve the same functionality.
1774 $wgDBcompress = false;
1777 * Separate username for maintenance tasks. Leave as null to use the default.
1779 $wgDBadminuser = null;
1782 * Separate password for maintenance tasks. Leave as null to use the default.
1784 $wgDBadminpassword = null;
1788 * Leave as null to select the default search engine for the
1789 * selected database type (eg SearchMySQL), or set to a class
1790 * name to override to a custom search engine.
1792 $wgSearchType = null;
1795 * Alternative search types
1796 * Sometimes you want to support multiple search engines for testing. This
1797 * allows users to select their search engine of choice via url parameters
1798 * to Special:Search and the action=search API. If using this, there's no
1799 * need to add $wgSearchType to it, that is handled automatically.
1801 $wgSearchTypeAlternatives = null;
1809 * MySQL table options to use during installation or update
1811 $wgDBTableOptions = 'ENGINE=InnoDB';
1814 * SQL Mode - default is turning off all modes, including strict, if set.
1815 * null can be used to skip the setting for performance reasons and assume
1816 * DBA has done his best job.
1817 * String override can be used for some additional fun :-)
1824 $wgDBmwschema = null;
1827 * To override default SQLite data directory ($docroot/../data)
1829 $wgSQLiteDataDir = '';
1832 * Make all database connections secretly go to localhost. Fool the load balancer
1833 * thinking there is an arbitrarily large cluster of servers to connect to.
1834 * Useful for debugging.
1836 $wgAllDBsAreLocalhost = false;
1839 * Shared database for multiple wikis. Commonly used for storing a user table
1840 * for single sign-on. The server for this database must be the same as for the
1843 * For backwards compatibility the shared prefix is set to the same as the local
1844 * prefix, and the user table is listed in the default list of shared tables.
1845 * The user_properties table is also added so that users will continue to have their
1846 * preferences shared (preferences were stored in the user table prior to 1.16)
1848 * $wgSharedTables may be customized with a list of tables to share in the shared
1849 * database. However it is advised to limit what tables you do share as many of
1850 * MediaWiki's tables may have side effects if you try to share them.
1852 * $wgSharedPrefix is the table prefix for the shared database. It defaults to
1855 * $wgSharedSchema is the table schema for the shared database. It defaults to
1858 * @deprecated since 1.21 In new code, use the $wiki parameter to wfGetLB() to
1859 * access remote databases. Using wfGetLB() allows the shared database to
1860 * reside on separate servers to the wiki's own database, with suitable
1861 * configuration of $wgLBFactoryConf.
1868 $wgSharedPrefix = false;
1873 $wgSharedTables = [ 'user', 'user_properties' ];
1879 $wgSharedSchema = false;
1882 * Database load balancer
1883 * This is a two-dimensional array, an array of server info structures
1886 * - dbname: Default database name
1888 * - password: DB password
1891 * - load: Ratio of DB_SLAVE load, must be >=0, the sum of all loads must be >0.
1892 * If this is zero for any given server, no normal query traffic will be
1893 * sent to it. It will be excluded from lag checks in maintenance scripts.
1894 * The only way it can receive traffic is if groupLoads is used.
1896 * - groupLoads: array of load ratios, the key is the query group name. A query may belong
1897 * to several groups, the most specific group defined here is used.
1899 * - flags: bit field
1900 * - DBO_DEFAULT -- turns on DBO_TRX only if !$wgCommandLineMode (recommended)
1901 * - DBO_DEBUG -- equivalent of $wgDebugDumpSql
1902 * - DBO_TRX -- wrap entire request in a transaction
1903 * - DBO_NOBUFFER -- turn off buffering (not useful in LocalSettings.php)
1904 * - DBO_PERSISTENT -- enables persistent database connections
1905 * - DBO_SSL -- uses SSL/TLS encryption in database connections, if available
1906 * - DBO_COMPRESS -- uses internal compression in database connections,
1909 * - max lag: (optional) Maximum replication lag before a slave will taken out of rotation
1910 * - is static: (optional) Set to true if the dataset is static and no replication is used.
1912 * These and any other user-defined properties will be assigned to the mLBInfo member
1913 * variable of the Database object.
1915 * Leave at false to use the single-server variables above. If you set this
1916 * variable, the single-server variables will generally be ignored (except
1917 * perhaps in some command-line scripts).
1919 * The first server listed in this array (with key 0) will be the master. The
1920 * rest of the servers will be slaves. To prevent writes to your slaves due to
1921 * accidental misconfiguration or MediaWiki bugs, set read_only=1 on all your
1922 * slaves in my.cnf. You can set read_only mode at runtime using:
1925 * SET @@read_only=1;
1928 * Since the effect of writing to a slave is so damaging and difficult to clean
1929 * up, we at Wikimedia set read_only=1 in my.cnf on all our DB servers, even
1930 * our masters, and then set read_only=0 on masters at runtime.
1932 $wgDBservers = false;
1935 * Load balancer factory configuration
1936 * To set up a multi-master wiki farm, set the class here to something that
1937 * can return a LoadBalancer with an appropriate master on a call to getMainLB().
1938 * The class identified here is responsible for reading $wgDBservers,
1939 * $wgDBserver, etc., so overriding it may cause those globals to be ignored.
1941 * The LBFactoryMulti class is provided for this purpose, please see
1942 * includes/db/LBFactoryMulti.php for configuration information.
1944 $wgLBFactoryConf = [ 'class' => 'LBFactorySimple' ];
1947 * After a state-changing request is done by a client, this determines
1948 * how many seconds that client should keep using the master datacenter.
1949 * This avoids unexpected stale or 404 responses due to replication lag.
1952 $wgDataCenterUpdateStickTTL = 10;
1955 * File to log database errors to
1957 $wgDBerrorLog = false;
1960 * Timezone to use in the error log.
1961 * Defaults to the wiki timezone ($wgLocaltimezone).
1963 * A list of usable timezones can found at:
1964 * http://php.net/manual/en/timezones.php
1968 * $wgDBerrorLogTZ = 'UTC';
1969 * $wgDBerrorLogTZ = 'GMT';
1970 * $wgDBerrorLogTZ = 'PST8PDT';
1971 * $wgDBerrorLogTZ = 'Europe/Sweden';
1972 * $wgDBerrorLogTZ = 'CET';
1977 $wgDBerrorLogTZ = false;
1980 * Set to true to engage MySQL 4.1/5.0 charset-related features;
1981 * for now will just cause sending of 'SET NAMES=utf8' on connect.
1983 * @warning THIS IS EXPERIMENTAL!
1985 * May break if you're not using the table defs from mysql5/tables.sql.
1986 * May break if you're upgrading an existing wiki if set differently.
1987 * Broken symptoms likely to include incorrect behavior with page titles,
1988 * usernames, comments etc containing non-ASCII characters.
1989 * Might also cause failures on the object cache and other things.
1991 * Even correct usage may cause failures with Unicode supplementary
1992 * characters (those not in the Basic Multilingual Plane) unless MySQL
1993 * has enhanced their Unicode support.
1995 $wgDBmysql5 = false;
1998 * Set true to enable Oracle DCRP (supported from 11gR1 onward)
2000 * To use this feature set to true and use a datasource defined as
2001 * POOLED (i.e. in tnsnames definition set server=pooled in connect_data
2004 * Starting from 11gR1 you can use DCRP (Database Resident Connection
2005 * Pool) that maintains established sessions and reuses them on new
2008 * Not completely tested, but it should fall back on normal connection
2009 * in case the pool is full or the datasource is not configured as
2011 * And the other way around; using oci_pconnect on a non pooled
2012 * datasource should produce a normal connection.
2014 * When it comes to frequent shortlived DB connections like with MW
2015 * Oracle tends to s***. The problem is the driver connects to the
2016 * database reasonably fast, but establishing a session takes time and
2017 * resources. MW does not rely on session state (as it does not use
2018 * features such as package variables) so establishing a valid session
2019 * is in this case an unwanted overhead that just slows things down.
2021 * @warning EXPERIMENTAL!
2024 $wgDBOracleDRCP = false;
2027 * Other wikis on this site, can be administered from a single developer
2029 * Array numeric key => database name
2031 $wgLocalDatabases = [];
2034 * If lag is higher than $wgSlaveLagWarning, show a warning in some special
2035 * pages (like watchlist). If the lag is higher than $wgSlaveLagCritical,
2036 * show a more obvious warning.
2038 $wgSlaveLagWarning = 10;
2041 * @see $wgSlaveLagWarning
2043 $wgSlaveLagCritical = 30;
2046 * Use Windows Authentication instead of $wgDBuser / $wgDBpassword for MS SQL Server
2048 $wgDBWindowsAuthentication = false;
2050 /**@}*/ # End of DB settings }
2052 /************************************************************************//**
2053 * @name Text storage
2058 * We can also compress text stored in the 'text' table. If this is set on, new
2059 * revisions will be compressed on page save if zlib support is available. Any
2060 * compressed revisions will be decompressed on load regardless of this setting,
2061 * but will not be readable at all* if zlib support is not available.
2063 $wgCompressRevisions = false;
2066 * External stores allow including content
2067 * from non database sources following URL links.
2069 * Short names of ExternalStore classes may be specified in an array here:
2071 * $wgExternalStores = [ "http","file","custom" ]...
2074 * CAUTION: Access to database might lead to code execution
2076 $wgExternalStores = [];
2079 * An array of external MySQL servers.
2082 * Create a cluster named 'cluster1' containing three servers:
2084 * $wgExternalServers = [
2085 * 'cluster1' => [ 'srv28', 'srv29', 'srv30' ]
2089 * Used by LBFactorySimple, may be ignored if $wgLBFactoryConf is set to
2092 $wgExternalServers = [];
2095 * The place to put new revisions, false to put them in the local text table.
2096 * Part of a URL, e.g. DB://cluster1
2098 * Can be an array instead of a single string, to enable data distribution. Keys
2099 * must be consecutive integers, starting at zero.
2103 * $wgDefaultExternalStore = [ 'DB://cluster1', 'DB://cluster2' ];
2108 $wgDefaultExternalStore = false;
2111 * Revision text may be cached in $wgMemc to reduce load on external storage
2112 * servers and object extraction overhead for frequently-loaded revisions.
2114 * Set to 0 to disable, or number of seconds before cache expiry.
2116 $wgRevisionCacheExpiry = 0;
2118 /** @} */ # end text storage }
2120 /************************************************************************//**
2121 * @name Performance hacks and limits
2126 * Disable database-intensive features
2128 $wgMiserMode = false;
2131 * Disable all query pages if miser mode is on, not just some
2133 $wgDisableQueryPages = false;
2136 * Number of rows to cache in 'querycache' table when miser mode is on
2138 $wgQueryCacheLimit = 1000;
2141 * Number of links to a page required before it is deemed "wanted"
2143 $wgWantedPagesThreshold = 1;
2146 * Enable slow parser functions
2148 $wgAllowSlowParserFunctions = false;
2151 * Allow schema updates
2153 $wgAllowSchemaUpdates = true;
2156 * Maximum article size in kilobytes
2158 $wgMaxArticleSize = 2048;
2161 * The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to
2162 * raise PHP's memory limit if it's below this amount.
2164 $wgMemoryLimit = "50M";
2167 * The minimum amount of time that MediaWiki needs for "slow" write request,
2168 * particularly ones with multiple non-atomic writes that *should* be as
2169 * transactional as possible; MediaWiki will call set_time_limit() if needed.
2172 $wgTransactionalTimeLimit = 120;
2174 /** @} */ # end performance hacks }
2176 /************************************************************************//**
2177 * @name Cache settings
2182 * Directory for caching data in the local filesystem. Should not be accessible
2185 * Note: if multiple wikis share the same localisation cache directory, they
2186 * must all have the same set of extensions. You can set a directory just for
2187 * the localisation cache using $wgLocalisationCacheConf['storeDirectory'].
2189 $wgCacheDirectory = false;
2192 * Main cache type. This should be a cache with fast access, but it may have
2193 * limited space. By default, it is disabled, since the stock database cache
2194 * is not fast enough to make it worthwhile.
2198 * - CACHE_ANYTHING: Use anything, as long as it works
2199 * - CACHE_NONE: Do not cache
2200 * - CACHE_DB: Store cache objects in the DB
2201 * - CACHE_MEMCACHED: MemCached, must specify servers in $wgMemCachedServers
2202 * - CACHE_ACCEL: APC, XCache or WinCache
2203 * - (other): A string may be used which identifies a cache
2204 * configuration in $wgObjectCaches.
2206 * @see $wgMessageCacheType, $wgParserCacheType
2208 $wgMainCacheType = CACHE_NONE
;
2211 * The cache type for storing the contents of the MediaWiki namespace. This
2212 * cache is used for a small amount of data which is expensive to regenerate.
2214 * For available types see $wgMainCacheType.
2216 $wgMessageCacheType = CACHE_ANYTHING
;
2219 * The cache type for storing article HTML. This is used to store data which
2220 * is expensive to regenerate, and benefits from having plenty of storage space.
2222 * For available types see $wgMainCacheType.
2224 $wgParserCacheType = CACHE_ANYTHING
;
2227 * The cache type for storing session data.
2229 * For available types see $wgMainCacheType.
2231 $wgSessionCacheType = CACHE_ANYTHING
;
2234 * The cache type for storing language conversion tables,
2235 * which are used when parsing certain text and interface messages.
2237 * For available types see $wgMainCacheType.
2241 $wgLanguageConverterCacheType = CACHE_ANYTHING
;
2244 * Advanced object cache configuration.
2246 * Use this to define the class names and constructor parameters which are used
2247 * for the various cache types. Custom cache types may be defined here and
2248 * referenced from $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType,
2249 * or $wgLanguageConverterCacheType.
2251 * The format is an associative array where the key is a cache identifier, and
2252 * the value is an associative array of parameters. The "class" parameter is the
2253 * class name which will be used. Alternatively, a "factory" parameter may be
2254 * given, giving a callable function which will generate a suitable cache object.
2257 CACHE_NONE
=> [ 'class' => 'EmptyBagOStuff', 'reportDupes' => false ],
2258 CACHE_DB
=> [ 'class' => 'SqlBagOStuff', 'loggroup' => 'SQLBagOStuff' ],
2260 CACHE_ANYTHING
=> [ 'factory' => 'ObjectCache::newAnything' ],
2261 CACHE_ACCEL
=> [ 'factory' => 'ObjectCache::getLocalServerInstance' ],
2262 CACHE_MEMCACHED
=> [ 'class' => 'MemcachedPhpBagOStuff', 'loggroup' => 'memcached' ],
2264 'db-replicated' => [
2265 'class' => 'ReplicatedBagOStuff',
2267 'class' => 'SqlBagOStuff',
2268 'args' => [ [ 'slaveOnly' => true ] ]
2271 'class' => 'SqlBagOStuff',
2272 'args' => [ [ 'slaveOnly' => false ] ]
2274 'loggroup' => 'SQLBagOStuff'
2277 'apc' => [ 'class' => 'APCBagOStuff', 'reportDupes' => false ],
2278 'xcache' => [ 'class' => 'XCacheBagOStuff', 'reportDupes' => false ],
2279 'wincache' => [ 'class' => 'WinCacheBagOStuff', 'reportDupes' => false ],
2280 'memcached-php' => [ 'class' => 'MemcachedPhpBagOStuff', 'loggroup' => 'memcached' ],
2281 'memcached-pecl' => [ 'class' => 'MemcachedPeclBagOStuff', 'loggroup' => 'memcached' ],
2282 'hash' => [ 'class' => 'HashBagOStuff', 'reportDupes' => false ],
2286 * Main Wide-Area-Network cache type. This should be a cache with fast access,
2287 * but it may have limited space. By default, it is disabled, since the basic stock
2288 * cache is not fast enough to make it worthwhile. For single data-center setups, this can
2289 * simply be pointed to a cache in $wgWANObjectCaches that uses a local $wgObjectCaches
2290 * cache with a relayer of type EventRelayerNull.
2293 * - false: Configure the cache using $wgMainCacheType, without using
2294 * a relayer (only matters if there are multiple data-centers)
2295 * - CACHE_NONE: Do not cache
2296 * - (other): A string may be used which identifies a cache
2297 * configuration in $wgWANObjectCaches
2300 $wgMainWANCache = false;
2303 * Advanced WAN object cache configuration.
2305 * Each WAN cache wraps a registered object cache (for the local cluster)
2306 * and it must also be configured to point to a PubSub instance. Subscribers
2307 * must be configured to relay purges to the actual cache servers.
2309 * The format is an associative array where the key is a cache identifier, and
2310 * the value is an associative array of parameters. The "cacheId" parameter is
2311 * a cache identifier from $wgObjectCaches. The "channels" parameter is a map of
2312 * actions ('purge') to PubSub channels defined in $wgEventRelayerConfig.
2313 * The "loggroup" parameter controls where log events are sent.
2317 $wgWANObjectCaches = [
2319 'class' => 'WANObjectCache',
2320 'cacheId' => CACHE_NONE
,
2323 /* Example of a simple single data-center cache:
2324 'memcached-php' => [
2325 'class' => 'WANObjectCache',
2326 'cacheId' => 'memcached-php',
2327 'channels' => [ 'purge' => 'wancache-main-memcached-purge' ]
2333 * Main object stash type. This should be a fast storage system for storing
2334 * lightweight data like hit counters and user activity. Sites with multiple
2335 * data-centers should have this use a store that replicates all writes. The
2336 * store should have enough consistency for CAS operations to be usable.
2337 * Reads outside of those needed for merge() may be eventually consistent.
2340 * - db: Store cache objects in the DB
2341 * - (other): A string may be used which identifies a cache
2342 * configuration in $wgObjectCaches
2346 $wgMainStash = 'db-replicated';
2349 * The expiry time for the parser cache, in seconds.
2350 * The default is 86400 (one day).
2352 $wgParserCacheExpireTime = 86400;
2355 * Deprecated alias for $wgSessionsInObjectCache.
2357 * @deprecated since 1.20; Use $wgSessionsInObjectCache
2359 $wgSessionsInMemcached = true;
2362 * @deprecated since 1.27, session data is always stored in object cache.
2364 $wgSessionsInObjectCache = true;
2367 * The expiry time to use for session storage, in seconds.
2369 $wgObjectCacheSessionExpiry = 3600;
2372 * @deprecated since 1.27, MediaWiki\Session\SessionManager doesn't use PHP session storage.
2374 $wgSessionHandler = null;
2377 * Whether to use PHP session handling ($_SESSION and session_*() functions)
2379 * If the constant MW_NO_SESSION is defined, this is forced to 'disable'.
2381 * If the constant MW_NO_SESSION_HANDLER is defined, this is ignored and PHP
2382 * session handling will function independently of SessionHandler.
2383 * SessionHandler and PHP's session handling may attempt to override each
2388 * - 'enable': Integrate with PHP's session handling as much as possible.
2389 * - 'warn': Integrate but log warnings if anything changes $_SESSION.
2390 * - 'disable': Throw exceptions if PHP session handling is used.
2392 $wgPHPSessionHandling = 'enable';
2395 * Number of internal PBKDF2 iterations to use when deriving session secrets.
2399 $wgSessionPbkdf2Iterations = 10001;
2402 * If enabled, will send MemCached debugging information to $wgDebugLogFile
2404 $wgMemCachedDebug = false;
2407 * The list of MemCached servers and port numbers
2409 $wgMemCachedServers = [ '127.0.0.1:11211' ];
2412 * Use persistent connections to MemCached, which are shared across multiple
2415 $wgMemCachedPersistent = false;
2418 * Read/write timeout for MemCached server communication, in microseconds.
2420 $wgMemCachedTimeout = 500000;
2423 * Set this to true to maintain a copy of the message cache on the local server.
2425 * This layer of message cache is in addition to the one configured by $wgMessageCacheType.
2427 * The local copy is put in APC. If APC is not installed, this setting does nothing.
2429 * Note that this is about the message cache, which stores interface messages
2430 * maintained as wiki pages. This is separate from the localisation cache for interface
2431 * messages provided by the software, which is configured by $wgLocalisationCacheConf.
2433 $wgUseLocalMessageCache = false;
2436 * Instead of caching everything, only cache those messages which have
2437 * been customised in the site content language. This means that
2438 * MediaWiki:Foo/ja is ignored if MediaWiki:Foo doesn't exist.
2439 * This option is probably only useful for translatewiki.net.
2441 $wgAdaptiveMessageCache = false;
2444 * Localisation cache configuration. Associative array with keys:
2445 * class: The class to use. May be overridden by extensions.
2447 * store: The location to store cache data. May be 'files', 'array', 'db' or
2448 * 'detect'. If set to "files", data will be in CDB files. If set
2449 * to "db", data will be stored to the database. If set to
2450 * "detect", files will be used if $wgCacheDirectory is set,
2451 * otherwise the database will be used.
2452 * "array" is an experimental option that uses PHP files that
2453 * store static arrays.
2455 * storeClass: The class name for the underlying storage. If set to a class
2456 * name, it overrides the "store" setting.
2458 * storeDirectory: If the store class puts its data in files, this is the
2459 * directory it will use. If this is false, $wgCacheDirectory
2462 * manualRecache: Set this to true to disable cache updates on web requests.
2463 * Use maintenance/rebuildLocalisationCache.php instead.
2465 $wgLocalisationCacheConf = [
2466 'class' => 'LocalisationCache',
2467 'store' => 'detect',
2468 'storeClass' => false,
2469 'storeDirectory' => false,
2470 'manualRecache' => false,
2474 * Allow client-side caching of pages
2476 $wgCachePages = true;
2479 * Set this to current time to invalidate all prior cached pages. Affects both
2480 * client-side and server-side caching.
2481 * You can get the current date on your server by using the command:
2483 * date +%Y%m%d%H%M%S
2486 $wgCacheEpoch = '20030516000000';
2489 * Directory where GitInfo will look for pre-computed cache files. If false,
2490 * $wgCacheDirectory/gitinfo will be used.
2492 $wgGitInfoCacheDirectory = false;
2495 * Bump this number when changing the global style sheets and JavaScript.
2497 * It should be appended in the query string of static CSS and JS includes,
2498 * to ensure that client-side caches do not keep obsolete copies of global
2501 $wgStyleVersion = '303';
2504 * This will cache static pages for non-logged-in users to reduce
2505 * database traffic on public sites. ResourceLoader requests to default
2506 * language and skins are cached as well as single module requests.
2508 $wgUseFileCache = false;
2511 * Depth of the subdirectory hierarchy to be created under
2512 * $wgFileCacheDirectory. The subdirectories will be named based on
2513 * the MD5 hash of the title. A value of 0 means all cache files will
2514 * be put directly into the main file cache directory.
2516 $wgFileCacheDepth = 2;
2519 * Kept for extension compatibility; see $wgParserCacheType
2522 $wgEnableParserCache = true;
2525 * Append a configured value to the parser cache and the sitenotice key so
2526 * that they can be kept separate for some class of activity.
2528 $wgRenderHashAppend = '';
2531 * If on, the sidebar navigation links are cached for users with the
2532 * current language set. This can save a touch of load on a busy site
2533 * by shaving off extra message lookups.
2535 * However it is also fragile: changing the site configuration, or
2536 * having a variable $wgArticlePath, can produce broken links that
2537 * don't update as expected.
2539 $wgEnableSidebarCache = false;
2542 * Expiry time for the sidebar cache, in seconds
2544 $wgSidebarCacheExpiry = 86400;
2547 * When using the file cache, we can store the cached HTML gzipped to save disk
2548 * space. Pages will then also be served compressed to clients that support it.
2550 * Requires zlib support enabled in PHP.
2555 * Clock skew or the one-second resolution of time() can occasionally cause cache
2556 * problems when the user requests two pages within a short period of time. This
2557 * variable adds a given number of seconds to vulnerable timestamps, thereby giving
2560 $wgClockSkewFudge = 5;
2563 * Invalidate various caches when LocalSettings.php changes. This is equivalent
2564 * to setting $wgCacheEpoch to the modification time of LocalSettings.php, as
2565 * was previously done in the default LocalSettings.php file.
2567 * On high-traffic wikis, this should be set to false, to avoid the need to
2568 * check the file modification time, and to avoid the performance impact of
2569 * unnecessary cache invalidations.
2571 $wgInvalidateCacheOnLocalSettingsChange = true;
2574 * When loading extensions through the extension registration system, this
2575 * can be used to invalidate the cache. A good idea would be to set this to
2576 * one file, you can just `touch` that one to invalidate the cache
2580 * $wgExtensionInfoMtime = filemtime( "$IP/LocalSettings.php" );
2583 * If set to false, the mtime for each individual JSON file will be checked,
2584 * which can be slow if a large number of extensions are being loaded.
2588 $wgExtensionInfoMTime = false;
2590 /** @} */ # end of cache settings
2592 /************************************************************************//**
2593 * @name HTTP proxy (CDN) settings
2595 * Many of these settings apply to any HTTP proxy used in front of MediaWiki,
2596 * although they are referred to as Squid settings for historical reasons.
2598 * Achieving a high hit ratio with an HTTP proxy requires special
2599 * configuration. See https://www.mediawiki.org/wiki/Manual:Squid_caching for
2606 * Enable/disable CDN.
2607 * See https://www.mediawiki.org/wiki/Manual:Squid_caching
2609 $wgUseSquid = false;
2612 * If you run Squid3 with ESI support, enable this (default:false):
2617 * Send the Key HTTP header for better caching.
2618 * See https://datatracker.ietf.org/doc/draft-fielding-http-key/ for details.
2621 $wgUseKeyHeader = false;
2624 * Add X-Forwarded-Proto to the Vary and Key headers for API requests and
2625 * RSS/Atom feeds. Use this if you have an SSL termination setup
2626 * and need to split the cache between HTTP and HTTPS for API requests,
2627 * feed requests and HTTP redirect responses in order to prevent cache
2628 * pollution. This does not affect 'normal' requests to index.php other than
2631 $wgVaryOnXFP = false;
2634 * Internal server name as known to CDN, if different.
2638 * $wgInternalServer = 'http://yourinternal.tld:8000';
2641 $wgInternalServer = false;
2644 * Cache TTL for the CDN sent as s-maxage (without ESI) or
2645 * Surrogate-Control (with ESI). Without ESI, you should strip
2646 * out s-maxage in the CDN config.
2648 * 18000 seconds = 5 hours, more cache hits with 2678400 = 31 days.
2650 $wgSquidMaxage = 18000;
2653 * Cache timeout for the CDN when DB slave lag is high
2654 * @see $wgSquidMaxage
2657 $wgCdnMaxageLagged = 30;
2660 * If set, any SquidPurge call on a URL or URLs will send a second purge no less than
2661 * this many seconds later via the job queue. This requires delayed job support.
2662 * This should be safely higher than the 'max lag' value in $wgLBFactoryConf, so that
2663 * slave lag does not cause page to be stuck in stales states in CDN.
2665 * This also fixes race conditions in two-tiered CDN setups (e.g. cdn2 => cdn1 => MediaWiki).
2666 * If a purge for a URL reaches cdn2 before cdn1 and a request reaches cdn2 for that URL,
2667 * it will populate the response from the stale cdn1 value. When cdn1 gets the purge, cdn2
2668 * will still be stale. If the rebound purge delay is safely higher than the time to relay
2669 * a purge to all nodes, then the rebound puge will clear cdn2 after cdn1 was cleared.
2673 $wgCdnReboundPurgeDelay = 0;
2676 * Cache timeout for the CDN when a response is known to be wrong or incomplete (due to load)
2677 * @see $wgSquidMaxage
2680 $wgCdnMaxageSubstitute = 60;
2683 * Default maximum age for raw CSS/JS accesses
2685 * 300 seconds = 5 minutes.
2687 $wgForcedRawSMaxage = 300;
2690 * List of proxy servers to purge on changes; default port is 80. Use IP addresses.
2692 * When MediaWiki is running behind a proxy, it will trust X-Forwarded-For
2693 * headers sent/modified from these proxies when obtaining the remote IP address
2695 * For a list of trusted servers which *aren't* purged, see $wgSquidServersNoPurge.
2697 $wgSquidServers = [];
2700 * As above, except these servers aren't purged on page changes; use to set a
2701 * list of trusted proxies, etc. Supports both individual IP addresses and
2703 * @since 1.23 Supports CIDR ranges
2705 $wgSquidServersNoPurge = [];
2708 * Whether to use a Host header in purge requests sent to the proxy servers
2709 * configured in $wgSquidServers. Set this to false to support Squid
2710 * configured in forward-proxy mode.
2712 * If this is set to true, a Host header will be sent, and only the path
2713 * component of the URL will appear on the request line, as if the request
2714 * were a non-proxy HTTP 1.1 request. Varnish only supports this style of
2715 * request. Squid supports this style of request only if reverse-proxy mode
2716 * (http_port ... accel) is enabled.
2718 * If this is set to false, no Host header will be sent, and the absolute URL
2719 * will be sent in the request line, as is the standard for an HTTP proxy
2720 * request in both HTTP 1.0 and 1.1. This style of request is not supported
2721 * by Varnish, but is supported by Squid in either configuration (forward or
2726 $wgSquidPurgeUseHostHeader = true;
2729 * Routing configuration for HTCP multicast purging. Add elements here to
2730 * enable HTCP and determine which purges are sent where. If set to an empty
2731 * array, HTCP is disabled.
2733 * Each key in this array is a regular expression to match against the purged
2734 * URL, or an empty string to match all URLs. The purged URL is matched against
2735 * the regexes in the order specified, and the first rule whose regex matches
2736 * is used, all remaining rules will thus be ignored.
2738 * @par Example configuration to send purges for upload.wikimedia.org to one
2739 * multicast group and all other purges to another:
2741 * $wgHTCPRouting = [
2742 * '|^https?://upload\.wikimedia\.org|' => [
2743 * 'host' => '239.128.0.113',
2747 * 'host' => '239.128.0.112',
2753 * You can also pass an array of hosts to send purges too. This is useful when
2754 * you have several multicast groups or unicast address that should receive a
2755 * given purge. Multiple hosts support was introduced in MediaWiki 1.22.
2757 * @par Example of sending purges to multiple hosts:
2759 * $wgHTCPRouting = [
2761 * // Purges to text caches using multicast
2762 * [ 'host' => '239.128.0.114', 'port' => '4827' ],
2763 * // Purges to a hardcoded list of caches
2764 * [ 'host' => '10.88.66.1', 'port' => '4827' ],
2765 * [ 'host' => '10.88.66.2', 'port' => '4827' ],
2766 * [ 'host' => '10.88.66.3', 'port' => '4827' ],
2773 * $wgHTCPRouting replaces $wgHTCPMulticastRouting that was introduced in 1.20.
2774 * For back compatibility purposes, whenever its array is empty
2775 * $wgHTCPMutlicastRouting will be used as a fallback if it not null.
2777 * @see $wgHTCPMulticastTTL
2779 $wgHTCPRouting = [];
2782 * HTCP multicast TTL.
2783 * @see $wgHTCPRouting
2785 $wgHTCPMulticastTTL = 1;
2788 * Should forwarded Private IPs be accepted?
2790 $wgUsePrivateIPs = false;
2792 /** @} */ # end of HTTP proxy settings
2794 /************************************************************************//**
2795 * @name Language, regional and character encoding settings
2800 * Site language code. See languages/data/Names.php for languages supported by
2801 * MediaWiki out of the box. Not all languages listed there have translations,
2802 * see languages/messages/ for the list of languages with some localisation.
2804 * Warning: Don't use language codes listed in $wgDummyLanguageCodes like "no"
2805 * for Norwegian (use "nb" instead), or things will break unexpectedly.
2807 * This defines the default interface language for all users, but users can
2808 * change it in their preferences.
2810 * This also defines the language of pages in the wiki. The content is wrapped
2811 * in a html element with lang=XX attribute. This behavior can be overridden
2812 * via hooks, see Title::getPageLanguage.
2814 $wgLanguageCode = 'en';
2817 * Language cache size, or really how many languages can we handle
2818 * simultaneously without degrading to crawl speed.
2820 $wgLangObjCacheSize = 10;
2823 * Some languages need different word forms, usually for different cases.
2824 * Used in Language::convertGrammar().
2828 * $wgGrammarForms['en']['genitive']['car'] = 'car\'s';
2831 $wgGrammarForms = [];
2834 * Treat language links as magic connectors, not inline links
2836 $wgInterwikiMagic = true;
2839 * Hide interlanguage links from the sidebar
2841 $wgHideInterlanguageLinks = false;
2844 * List of additional interwiki prefixes that should be treated as
2845 * interlanguage links (i.e. placed in the sidebar).
2847 * - This will not do anything unless the prefixes are defined in the interwiki
2849 * - The display text for these custom interlanguage links will be fetched from
2850 * the system message "interlanguage-link-xyz" where xyz is the prefix in
2852 * - A friendly name for each site, used for tooltip text, may optionally be
2853 * placed in the system message "interlanguage-link-sitename-xyz" where xyz is
2854 * the prefix in this array.
2856 $wgExtraInterlanguageLinkPrefixes = [];
2859 * List of language names or overrides for default names in Names.php
2861 $wgExtraLanguageNames = [];
2864 * List of language codes that don't correspond to an actual language.
2865 * These codes are mostly left-offs from renames, or other legacy things.
2866 * This array makes them not appear as a selectable language on the installer,
2867 * and excludes them when running the transstat.php script.
2869 $wgDummyLanguageCodes = [
2872 'be-x-old' => 'be-tarask',
2876 'qqq' => 'qqq', # Used for message documentation.
2877 'qqx' => 'qqx', # Used for viewing message keys.
2880 'zh-classical' => 'lzh',
2881 'zh-min-nan' => 'nan',
2886 * Character set for use in the article edit box. Language-specific encodings
2889 * This historic feature is one of the first that was added by former MediaWiki
2890 * team leader Brion Vibber, and is used to support the Esperanto x-system.
2892 $wgEditEncoding = '';
2895 * Set this to true to replace Arabic presentation forms with their standard
2896 * forms in the U+0600-U+06FF block. This only works if $wgLanguageCode is
2899 * Note that pages with titles containing presentation forms will become
2900 * inaccessible, run maintenance/cleanupTitles.php to fix this.
2902 $wgFixArabicUnicode = true;
2905 * Set this to true to replace ZWJ-based chillu sequences in Malayalam text
2906 * with their Unicode 5.1 equivalents. This only works if $wgLanguageCode is
2907 * set to "ml". Note that some clients (even new clients as of 2010) do not
2908 * support these characters.
2910 * If you enable this on an existing wiki, run maintenance/cleanupTitles.php to
2911 * fix any ZWJ sequences in existing page titles.
2913 $wgFixMalayalamUnicode = true;
2916 * Set this to always convert certain Unicode sequences to modern ones
2917 * regardless of the content language. This has a small performance
2920 * See $wgFixArabicUnicode and $wgFixMalayalamUnicode for conversion
2925 $wgAllUnicodeFixes = false;
2928 * Set this to eg 'ISO-8859-1' to perform character set conversion when
2929 * loading old revisions not marked with "utf-8" flag. Use this when
2930 * converting a wiki from MediaWiki 1.4 or earlier to UTF-8 without the
2931 * burdensome mass conversion of old text data.
2933 * @note This DOES NOT touch any fields other than old_text. Titles, comments,
2934 * user names, etc still must be converted en masse in the database before
2935 * continuing as a UTF-8 wiki.
2937 $wgLegacyEncoding = false;
2940 * Browser Blacklist for unicode non compliant browsers. Contains a list of
2941 * regexps : "/regexp/" matching problematic browsers. These browsers will
2942 * be served encoded unicode in the edit box instead of real unicode.
2944 $wgBrowserBlackList = [
2946 * Netscape 2-4 detection
2947 * The minor version may contain strings such as "Gold" or "SGoldC-SGI"
2948 * Lots of non-netscape user agents have "compatible", so it's useful to check for that
2949 * with a negative assertion. The [UIN] identifier specifies the level of security
2950 * in a Netscape/Mozilla browser, checking for it rules out a number of fakers.
2951 * The language string is unreliable, it is missing on NS4 Mac.
2953 * Reference: http://www.psychedelix.com/agents/index.shtml
2955 '/^Mozilla\/2\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2956 '/^Mozilla\/3\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2957 '/^Mozilla\/4\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2960 * MSIE on Mac OS 9 is teh sux0r, converts þ to <thorn>, ð to <eth>,
2961 * Þ to <THORN> and Ð to <ETH>
2964 * - Mozilla/4.0 (compatible; MSIE 5.0; Mac_PowerPC)
2965 * - Mozilla/4.0 (compatible; MSIE 5.15; Mac_PowerPC)
2966 * - Mozilla/4.0 (compatible; MSIE 5.23; Mac_PowerPC)
2969 * @link https://en.wikipedia.org/w/index.php?diff=12356041&oldid=12355864
2970 * @link https://en.wikipedia.org/wiki/Template%3AOS9
2972 '/^Mozilla\/4\.0 \(compatible; MSIE \d+\.\d+; Mac_PowerPC\)/',
2975 * Google wireless transcoder, seems to eat a lot of chars alive
2976 * https://it.wikipedia.org/w/index.php?title=Luciano_Ligabue&diff=prev&oldid=8857361
2978 '/^Mozilla\/4\.0 \(compatible; MSIE 6.0; Windows NT 5.0; Google Wireless Transcoder;\)/'
2982 * If set to true, the MediaWiki 1.4 to 1.5 schema conversion will
2983 * create stub reference rows in the text table instead of copying
2984 * the full text of all current entries from 'cur' to 'text'.
2986 * This will speed up the conversion step for large sites, but
2987 * requires that the cur table be kept around for those revisions
2988 * to remain viewable.
2990 * This option affects the updaters *only*. Any present cur stub
2991 * revisions will be readable at runtime regardless of this setting.
2993 $wgLegacySchemaConversion = false;
2996 * Enable dates like 'May 12' instead of '12 May', if the default date format
2999 $wgAmericanDates = false;
3002 * For Hindi and Arabic use local numerals instead of Western style (0-9)
3003 * numerals in interface.
3005 $wgTranslateNumerals = true;
3008 * Translation using MediaWiki: namespace.
3009 * Interface messages will be loaded from the database.
3011 $wgUseDatabaseMessages = true;
3014 * Expiry time for the message cache key
3016 $wgMsgCacheExpiry = 86400;
3019 * Maximum entry size in the message cache, in bytes
3021 $wgMaxMsgCacheEntrySize = 10000;
3024 * Whether to enable language variant conversion.
3026 $wgDisableLangConversion = false;
3029 * Whether to enable language variant conversion for links.
3031 $wgDisableTitleConversion = false;
3034 * Default variant code, if false, the default will be the language code
3036 $wgDefaultLanguageVariant = false;
3039 * Disabled variants array of language variant conversion.
3043 * $wgDisabledVariants[] = 'zh-mo';
3044 * $wgDisabledVariants[] = 'zh-my';
3047 $wgDisabledVariants = [];
3050 * Like $wgArticlePath, but on multi-variant wikis, this provides a
3051 * path format that describes which parts of the URL contain the
3056 * $wgLanguageCode = 'sr';
3057 * $wgVariantArticlePath = '/$2/$1';
3058 * $wgArticlePath = '/wiki/$1';
3061 * A link to /wiki/ would be redirected to /sr/Главна_страна
3063 * It is important that $wgArticlePath not overlap with possible values
3064 * of $wgVariantArticlePath.
3066 $wgVariantArticlePath = false;
3069 * Show a bar of language selection links in the user login and user
3070 * registration forms; edit the "loginlanguagelinks" message to
3073 $wgLoginLanguageSelector = false;
3076 * When translating messages with wfMessage(), it is not always clear what
3077 * should be considered UI messages and what should be content messages.
3079 * For example, for the English Wikipedia, there should be only one 'mainpage',
3080 * so when getting the link for 'mainpage', we should treat it as site content
3081 * and call ->inContentLanguage()->text(), but for rendering the text of the
3082 * link, we call ->text(). The code behaves this way by default. However,
3083 * sites like the Wikimedia Commons do offer different versions of 'mainpage'
3084 * and the like for different languages. This array provides a way to override
3085 * the default behavior.
3088 * To allow language-specific main page and community
3091 * $wgForceUIMsgAsContentMsg = [ 'mainpage', 'portal-url' ];
3094 $wgForceUIMsgAsContentMsg = [];
3097 * Fake out the timezone that the server thinks it's in. This will be used for
3098 * date display and not for what's stored in the DB. Leave to null to retain
3099 * your server's OS-based timezone value.
3101 * This variable is currently used only for signature formatting and for local
3102 * time/date parser variables ({{LOCALTIME}} etc.)
3104 * Timezones can be translated by editing MediaWiki messages of type
3105 * timezone-nameinlowercase like timezone-utc.
3107 * A list of usable timezones can found at:
3108 * http://php.net/manual/en/timezones.php
3112 * $wgLocaltimezone = 'UTC';
3113 * $wgLocaltimezone = 'GMT';
3114 * $wgLocaltimezone = 'PST8PDT';
3115 * $wgLocaltimezone = 'Europe/Sweden';
3116 * $wgLocaltimezone = 'CET';
3119 $wgLocaltimezone = null;
3122 * Set an offset from UTC in minutes to use for the default timezone setting
3123 * for anonymous users and new user accounts.
3125 * This setting is used for most date/time displays in the software, and is
3126 * overridable in user preferences. It is *not* used for signature timestamps.
3128 * By default, this will be set to match $wgLocaltimezone.
3130 $wgLocalTZoffset = null;
3132 /** @} */ # End of language/charset settings
3134 /*************************************************************************//**
3135 * @name Output format and skin settings
3140 * The default Content-Type header.
3142 $wgMimeType = 'text/html';
3145 * Previously used as content type in HTML script tags. This is now ignored since
3146 * HTML5 doesn't require a MIME type for script tags (javascript is the default).
3147 * It was also previously used by RawAction to determine the ctype query parameter
3148 * value that will result in a javascript response.
3149 * @deprecated since 1.22
3151 $wgJsMimeType = null;
3154 * The default xmlns attribute. The option to define this has been removed.
3155 * The value of this variable is no longer used by core and is set to a fixed
3156 * value in Setup.php for compatibility with extensions that depend on the value
3157 * of this variable being set. Such a dependency however is deprecated.
3158 * @deprecated since 1.22
3160 $wgXhtmlDefaultNamespace = null;
3163 * Previously used to determine if we should output an HTML5 doctype.
3164 * This is no longer used as we always output HTML5 now. For compatibility with
3165 * extensions that still check the value of this config it's value is now forced
3166 * to true by Setup.php.
3167 * @deprecated since 1.22
3172 * Defines the value of the version attribute in the <html> tag, if any.
3174 * If your wiki uses RDFa, set it to the correct value for RDFa+HTML5.
3175 * Correct current values are 'HTML+RDFa 1.0' or 'XHTML+RDFa 1.0'.
3176 * See also http://www.w3.org/TR/rdfa-in-html/#document-conformance
3179 $wgHtml5Version = null;
3182 * Temporary variable that allows HTMLForms to be rendered as tables.
3183 * Table based layouts cause various issues when designing for mobile.
3184 * This global allows skins or extensions a means to force non-table based rendering.
3185 * Setting to false forces form components to always render as div elements.
3188 $wgHTMLFormAllowTableFormat = true;
3191 * Temporary variable that applies MediaWiki UI wherever it can be supported.
3192 * Temporary variable that should be removed when mediawiki ui is more
3193 * stable and change has been communicated.
3196 $wgUseMediaWikiUIEverywhere = false;
3199 * Permit other namespaces in addition to the w3.org default.
3201 * Use the prefix for the key and the namespace for the value.
3205 * $wgXhtmlNamespaces['svg'] = 'http://www.w3.org/2000/svg';
3207 * Normally we wouldn't have to define this in the root "<html>"
3208 * element, but IE needs it there in some circumstances.
3210 * This is ignored if $wgMimeType is set to a non-XML MIME type.
3212 $wgXhtmlNamespaces = [];
3215 * Site notice shown at the top of each page
3217 * MediaWiki:Sitenotice page, which will override this. You can also
3218 * provide a separate message for logged-out users using the
3219 * MediaWiki:Anonnotice page.
3224 * If this is set, a "donate" link will appear in the sidebar. Set it to a URL.
3226 $wgSiteSupportPage = '';
3229 * Validate the overall output using tidy and refuse
3230 * to display the page if it's not valid.
3232 $wgValidateAllHtml = false;
3235 * Default skin, for new users and anonymous visitors. Registered users may
3236 * change this to any one of the other available skins in their preferences.
3238 $wgDefaultSkin = 'vector';
3241 * Fallback skin used when the skin defined by $wgDefaultSkin can't be found.
3245 $wgFallbackSkin = 'fallback';
3248 * Specify the names of skins that should not be presented in the list of
3249 * available skins in user preferences. If you want to remove a skin entirely,
3250 * remove it from the skins/ directory and its entry from LocalSettings.php.
3255 * @deprecated since 1.23; use $wgSkipSkins instead
3260 * Allow user Javascript page?
3261 * This enables a lot of neat customizations, but may
3262 * increase security risk to users and server load.
3264 $wgAllowUserJs = false;
3267 * Allow user Cascading Style Sheets (CSS)?
3268 * This enables a lot of neat customizations, but may
3269 * increase security risk to users and server load.
3271 $wgAllowUserCss = false;
3274 * Allow user-preferences implemented in CSS?
3275 * This allows users to customise the site appearance to a greater
3276 * degree; disabling it will improve page load times.
3278 $wgAllowUserCssPrefs = true;
3281 * Use the site's Javascript page?
3283 $wgUseSiteJs = true;
3286 * Use the site's Cascading Style Sheets (CSS)?
3288 $wgUseSiteCss = true;
3291 * Break out of framesets. This can be used to prevent clickjacking attacks,
3292 * or to prevent external sites from framing your site with ads.
3294 $wgBreakFrames = false;
3297 * The X-Frame-Options header to send on pages sensitive to clickjacking
3298 * attacks, such as edit pages. This prevents those pages from being displayed
3299 * in a frame or iframe. The options are:
3301 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3303 * - 'SAMEORIGIN': Allow framing by pages on the same domain. This can be used
3304 * to allow framing within a trusted domain. This is insecure if there
3305 * is a page on the same domain which allows framing of arbitrary URLs.
3307 * - false: Allow all framing. This opens up the wiki to XSS attacks and thus
3308 * full compromise of local user accounts. Private wikis behind a
3309 * corporate firewall are especially vulnerable. This is not
3312 * For extra safety, set $wgBreakFrames = true, to prevent framing on all pages,
3313 * not just edit pages.
3315 $wgEditPageFrameOptions = 'DENY';
3318 * Disallow framing of API pages directly, by setting the X-Frame-Options
3319 * header. Since the API returns CSRF tokens, allowing the results to be
3320 * framed can compromise your user's account security.
3322 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3323 * - 'SAMEORIGIN': Allow framing by pages on the same domain.
3324 * - false: Allow all framing.
3325 * Note: $wgBreakFrames will override this for human formatted API output.
3327 $wgApiFrameOptions = 'DENY';
3330 * Disable output compression (enabled by default if zlib is available)
3332 $wgDisableOutputCompression = false;
3335 * Should we allow a broader set of characters in id attributes, per HTML5? If
3336 * not, use only HTML 4-compatible IDs. This option is for testing -- when the
3337 * functionality is ready, it will be on by default with no option.
3339 * Currently this appears to work fine in all browsers, but it's disabled by
3340 * default because it normalizes id's a bit too aggressively, breaking preexisting
3341 * content (particularly Cite). See bug 27733, bug 27694, bug 27474.
3343 $wgExperimentalHtmlIds = false;
3346 * Abstract list of footer icons for skins in place of old copyrightico and poweredbyico code
3347 * You can add new icons to the built in copyright or poweredby, or you can create
3348 * a new block. Though note that you may need to add some custom css to get good styling
3349 * of new blocks in monobook. vector and modern should work without any special css.
3351 * $wgFooterIcons itself is a key/value array.
3352 * The key is the name of a block that the icons will be wrapped in. The final id varies
3353 * by skin; Monobook and Vector will turn poweredby into f-poweredbyico while Modern
3354 * turns it into mw_poweredby.
3355 * The value is either key/value array of icons or a string.
3356 * In the key/value array the key may or may not be used by the skin but it can
3357 * be used to find the icon and unset it or change the icon if needed.
3358 * This is useful for disabling icons that are set by extensions.
3359 * The value should be either a string or an array. If it is a string it will be output
3360 * directly as html, however some skins may choose to ignore it. An array is the preferred format
3361 * for the icon, the following keys are used:
3362 * - src: An absolute url to the image to use for the icon, this is recommended
3363 * but not required, however some skins will ignore icons without an image
3364 * - srcset: optional additional-resolution images; see HTML5 specs
3365 * - url: The url to use in the a element around the text or icon, if not set an a element will
3367 * - alt: This is the text form of the icon, it will be displayed without an image in
3368 * skins like Modern or if src is not set, and will otherwise be used as
3369 * the alt="" for the image. This key is required.
3370 * - width and height: If the icon specified by src is not of the standard size
3371 * you can specify the size of image to use with these keys.
3372 * Otherwise they will default to the standard 88x31.
3373 * @todo Reformat documentation.
3377 "copyright" => [], // placeholder for the built in copyright icon
3381 // Defaults to point at
3382 // "$wgResourceBasePath/resources/assets/poweredby_mediawiki_88x31.png"
3383 // plus srcset for 1.5x, 2x resolution variants.
3385 "url" => "//www.mediawiki.org/",
3386 "alt" => "Powered by MediaWiki",
3392 * Login / create account link behavior when it's possible for anonymous users
3393 * to create an account.
3394 * - true = use a combined login / create account link
3395 * - false = split login and create account into two separate links
3397 $wgUseCombinedLoginLink = false;
3400 * Display user edit counts in various prominent places.
3402 $wgEdititis = false;
3405 * Some web hosts attempt to rewrite all responses with a 404 (not found)
3406 * status code, mangling or hiding MediaWiki's output. If you are using such a
3407 * host, you should start looking for a better one. While you're doing that,
3408 * set this to false to convert some of MediaWiki's 404 responses to 200 so
3409 * that the generated error pages can be seen.
3411 * In cases where for technical reasons it is more important for MediaWiki to
3412 * send the correct status code than for the body to be transmitted intact,
3413 * this configuration variable is ignored.
3415 $wgSend404Code = true;
3418 * The $wgShowRollbackEditCount variable is used to show how many edits can be rolled back.
3419 * The numeric value of the variable controls how many edits MediaWiki will look back to
3420 * determine whether a rollback is allowed (by checking that they are all from the same author).
3421 * If the value is false or 0, the edits are not counted. Disabling this will prevent MediaWiki
3422 * from hiding some useless rollback links.
3426 $wgShowRollbackEditCount = 10;
3429 * Output a <link rel="canonical"> tag on every page indicating the canonical
3430 * server which should be used, i.e. $wgServer or $wgCanonicalServer. Since
3431 * detection of the current server is unreliable, the link is sent
3434 $wgEnableCanonicalServerLink = false;
3437 * When OutputHandler is used, mangle any output that contains
3438 * <cross-domain-policy>. Without this, an attacker can send their own
3439 * cross-domain policy unless it is prevented by the crossdomain.xml file at
3444 $wgMangleFlashPolicy = true;
3446 /** @} */ # End of output format settings }
3448 /*************************************************************************//**
3449 * @name ResourceLoader settings
3454 * Client-side resource modules.
3456 * Extensions should add their ResourceLoader module definitions
3457 * to the $wgResourceModules variable.
3461 * $wgResourceModules['ext.myExtension'] = [
3462 * 'scripts' => 'myExtension.js',
3463 * 'styles' => 'myExtension.css',
3464 * 'dependencies' => [ 'jquery.cookie', 'jquery.tabIndex' ],
3465 * 'localBasePath' => __DIR__,
3466 * 'remoteExtPath' => 'MyExtension',
3470 $wgResourceModules = [];
3473 * Skin-specific styles for resource modules.
3475 * These are later added to the 'skinStyles' list of the existing module. The 'styles' list can
3476 * not be modified or disabled.
3478 * For example, here is a module "bar" and how skin Foo would provide additional styles for it.
3482 * $wgResourceModules['bar'] = [
3483 * 'scripts' => 'resources/bar/bar.js',
3484 * 'styles' => 'resources/bar/main.css',
3487 * $wgResourceModuleSkinStyles['foo'] = [
3488 * 'bar' => 'skins/Foo/bar.css',
3492 * This is mostly equivalent to:
3496 * $wgResourceModules['bar'] = [
3497 * 'scripts' => 'resources/bar/bar.js',
3498 * 'styles' => 'resources/bar/main.css',
3500 * 'foo' => skins/Foo/bar.css',
3505 * If the module already defines its own entry in `skinStyles` for a given skin, then
3506 * $wgResourceModuleSkinStyles is ignored.
3508 * If a module defines a `skinStyles['default']` the skin may want to extend that instead
3509 * of replacing them. This can be done using the `+` prefix.
3513 * $wgResourceModules['bar'] = [
3514 * 'scripts' => 'resources/bar/bar.js',
3515 * 'styles' => 'resources/bar/basic.css',
3517 * 'default' => 'resources/bar/additional.css',
3520 * // Note the '+' character:
3521 * $wgResourceModuleSkinStyles['foo'] = [
3522 * '+bar' => 'skins/Foo/bar.css',
3526 * This is mostly equivalent to:
3530 * $wgResourceModules['bar'] = [
3531 * 'scripts' => 'resources/bar/bar.js',
3532 * 'styles' => 'resources/bar/basic.css',
3534 * 'default' => 'resources/bar/additional.css',
3536 * 'resources/bar/additional.css',
3537 * 'skins/Foo/bar.css',
3543 * In other words, as a module author, use the `styles` list for stylesheets that may not be
3544 * disabled by a skin. To provide default styles that may be extended or replaced,
3545 * use `skinStyles['default']`.
3547 * As with $wgResourceModules, paths default to being relative to the MediaWiki root.
3548 * You should always provide a localBasePath and remoteBasePath (or remoteExtPath/remoteSkinPath).
3552 * $wgResourceModuleSkinStyles['foo'] = [
3553 * 'bar' => 'bar.css',
3554 * 'quux' => 'quux.css',
3555 * 'remoteSkinPath' => 'Foo',
3556 * 'localBasePath' => __DIR__,
3560 $wgResourceModuleSkinStyles = [];
3563 * Extensions should register foreign module sources here. 'local' is a
3564 * built-in source that is not in this array, but defined by
3565 * ResourceLoader::__construct() so that it cannot be unset.
3569 * $wgResourceLoaderSources['foo'] = 'http://example.org/w/load.php';
3572 $wgResourceLoaderSources = [];
3575 * The default 'remoteBasePath' value for instances of ResourceLoaderFileModule.
3576 * Defaults to $wgScriptPath.
3578 $wgResourceBasePath = null;
3581 * Maximum time in seconds to cache resources served by ResourceLoader.
3582 * Used to set last modified headers (max-age/s-maxage).
3584 * Following options to distinguish:
3585 * - versioned: Used for modules with a version, because changing version
3586 * numbers causes cache misses. This normally has a long expiry time.
3587 * - unversioned: Used for modules without a version to propagate changes
3588 * quickly to clients. Also used for modules with errors to recover quickly.
3589 * This normally has a short expiry time.
3591 * Expiry time for the options to distinguish:
3592 * - server: Squid/Varnish but also any other public proxy cache between the
3593 * client and MediaWiki.
3594 * - client: On the client side (e.g. in the browser cache).
3596 $wgResourceLoaderMaxage = [
3598 'server' => 30 * 24 * 60 * 60, // 30 days
3599 'client' => 30 * 24 * 60 * 60, // 30 days
3602 'server' => 5 * 60, // 5 minutes
3603 'client' => 5 * 60, // 5 minutes
3608 * The default debug mode (on/off) for of ResourceLoader requests.
3610 * This will still be overridden when the debug URL parameter is used.
3612 $wgResourceLoaderDebug = false;
3615 * Put each statement on its own line when minifying JavaScript. This makes
3616 * debugging in non-debug mode a bit easier.
3618 * @deprecated since 1.27: Always false; no longer configurable.
3620 $wgResourceLoaderMinifierStatementsOnOwnLine = false;
3623 * Maximum line length when minifying JavaScript. This is not a hard maximum:
3624 * the minifier will try not to produce lines longer than this, but may be
3625 * forced to do so in certain cases.
3627 * @deprecated since 1.27: Always 1,000; no longer configurable.
3629 $wgResourceLoaderMinifierMaxLineLength = 1000;
3632 * Whether to ensure the mediawiki.legacy library is loaded before other modules.
3634 * @deprecated since 1.26: Always declare dependencies.
3636 $wgIncludeLegacyJavaScript = false;
3639 * Whether or not to assign configuration variables to the global window object.
3641 * If this is set to false, old code using deprecated variables will no longer
3644 * @par Example of legacy code:
3646 * if ( window.wgRestrictionEdit ) { ... }
3650 * if ( wgIsArticle ) { ... }
3653 * Instead, one needs to use mw.config.
3654 * @par Example using mw.config global configuration:
3656 * if ( mw.config.exists('wgRestrictionEdit') ) { ... }
3660 * if ( mw.config.get('wgIsArticle') ) { ... }
3663 $wgLegacyJavaScriptGlobals = true;
3666 * If set to a positive number, ResourceLoader will not generate URLs whose
3667 * query string is more than this many characters long, and will instead use
3668 * multiple requests with shorter query strings. This degrades performance,
3669 * but may be needed if your web server has a low (less than, say 1024)
3670 * query string length limit or a low value for suhosin.get.max_value_length
3671 * that you can't increase.
3673 * If set to a negative number, ResourceLoader will assume there is no query
3674 * string length limit.
3676 * Defaults to a value based on php configuration.
3678 $wgResourceLoaderMaxQueryLength = false;
3681 * If set to true, JavaScript modules loaded from wiki pages will be parsed
3682 * prior to minification to validate it.
3684 * Parse errors will result in a JS exception being thrown during module load,
3685 * which avoids breaking other modules loaded in the same request.
3687 $wgResourceLoaderValidateJS = true;
3690 * If set to true, statically-sourced (file-backed) JavaScript resources will
3691 * be parsed for validity before being bundled up into ResourceLoader modules.
3693 * This can be helpful for development by providing better error messages in
3694 * default (non-debug) mode, but JavaScript parsing is slow and memory hungry
3695 * and may fail on large pre-bundled frameworks.
3697 $wgResourceLoaderValidateStaticJS = false;
3700 * Global LESS variables. An associative array binding variable names to
3701 * LESS code snippets representing their values.
3703 * Adding an item here is equivalent to writing `@variable: value;`
3704 * at the beginning of all your .less files, with all the consequences.
3705 * In particular, string values must be escaped and quoted.
3707 * Changes to LESS variables do not trigger cache invalidation.
3709 * If the LESS variables need to be dynamic, you can use the
3710 * ResourceLoaderGetLessVars hook (since 1.25).
3714 * $wgResourceLoaderLESSVars = [
3715 * 'baseFontSize' => '1em',
3716 * 'smallFontSize' => '0.75em',
3717 * 'WikimediaBlue' => '#006699',
3722 $wgResourceLoaderLESSVars = [
3724 * Minimum available screen width at which a device can be considered a tablet/desktop
3725 * The number is currently based on the device width of a Samsung Galaxy S5 mini and is low
3726 * enough to cover iPad (768px). Number is prone to change with new information.
3729 'deviceWidthTablet' => '720px',
3733 * Default import paths for LESS modules. LESS files referenced in @import
3734 * statements will be looked up here first, and relative to the importing file
3735 * second. To avoid collisions, it's important for the LESS files in these
3736 * directories to have a common, predictable file name prefix.
3738 * Extensions need not (and should not) register paths in
3739 * $wgResourceLoaderLESSImportPaths. The import path includes the path of the
3740 * currently compiling LESS file, which allows each extension to freely import
3741 * files from its own tree.
3745 $wgResourceLoaderLESSImportPaths = [
3746 "$IP/resources/src/mediawiki.less/",
3750 * Whether ResourceLoader should attempt to persist modules in localStorage on
3751 * browsers that support the Web Storage API.
3753 * @since 1.23 - Client-side module persistence is experimental. Exercise care.
3755 $wgResourceLoaderStorageEnabled = false;
3758 * Cache version for client-side ResourceLoader module storage. You can trigger
3759 * invalidation of the contents of the module store by incrementing this value.
3763 $wgResourceLoaderStorageVersion = 1;
3766 * Whether to allow site-wide CSS (MediaWiki:Common.css and friends) on
3767 * restricted pages like Special:UserLogin or Special:Preferences where
3768 * JavaScript is disabled for security reasons. As it is possible to
3769 * execute JavaScript through CSS, setting this to true opens up a
3770 * potential security hole. Some sites may "skin" their wiki by using
3771 * site-wide CSS, causing restricted pages to look unstyled and different
3772 * from the rest of the site.
3776 $wgAllowSiteCSSOnRestrictedPages = false;
3778 /** @} */ # End of ResourceLoader settings }
3780 /*************************************************************************//**
3781 * @name Page title and interwiki link settings
3786 * Name of the project namespace. If left set to false, $wgSitename will be
3789 $wgMetaNamespace = false;
3792 * Name of the project talk namespace.
3794 * Normally you can ignore this and it will be something like
3795 * $wgMetaNamespace . "_talk". In some languages, you may want to set this
3796 * manually for grammatical reasons.
3798 $wgMetaNamespaceTalk = false;
3801 * Additional namespaces. If the namespaces defined in Language.php and
3802 * Namespace.php are insufficient, you can create new ones here, for example,
3803 * to import Help files in other languages. You can also override the namespace
3804 * names of existing namespaces. Extensions should use the CanonicalNamespaces
3805 * hook or extension.json.
3807 * @warning Once you delete a namespace, the pages in that namespace will
3808 * no longer be accessible. If you rename it, then you can access them through
3809 * the new namespace name.
3811 * Custom namespaces should start at 100 to avoid conflicting with standard
3812 * namespaces, and should always follow the even/odd main/talk pattern.
3816 * $wgExtraNamespaces = [
3818 * 101 => "Hilfe_Diskussion",
3820 * 103 => "Discussion_Aide"
3824 * @todo Add a note about maintenance/namespaceDupes.php
3826 $wgExtraNamespaces = [];
3829 * Same as above, but for namespaces with gender distinction.
3830 * Note: the default form for the namespace should also be set
3831 * using $wgExtraNamespaces for the same index.
3834 $wgExtraGenderNamespaces = [];
3837 * Namespace aliases.
3839 * These are alternate names for the primary localised namespace names, which
3840 * are defined by $wgExtraNamespaces and the language file. If a page is
3841 * requested with such a prefix, the request will be redirected to the primary
3844 * Set this to a map from namespace names to IDs.
3848 * $wgNamespaceAliases = [
3849 * 'Wikipedian' => NS_USER,
3854 $wgNamespaceAliases = [];
3857 * Allowed title characters -- regex character class
3858 * Don't change this unless you know what you're doing
3860 * Problematic punctuation:
3861 * - []{}|# Are needed for link syntax, never enable these
3862 * - <> Causes problems with HTML escaping, don't use
3863 * - % Enabled by default, minor problems with path to query rewrite rules, see below
3864 * - + Enabled by default, but doesn't work with path to query rewrite rules,
3865 * corrupted by apache
3866 * - ? Enabled by default, but doesn't work with path to PATH_INFO rewrites
3868 * All three of these punctuation problems can be avoided by using an alias,
3869 * instead of a rewrite rule of either variety.
3871 * The problem with % is that when using a path to query rewrite rule, URLs are
3872 * double-unescaped: once by Apache's path conversion code, and again by PHP. So
3873 * %253F, for example, becomes "?". Our code does not double-escape to compensate
3874 * for this, indeed double escaping would break if the double-escaped title was
3875 * passed in the query string rather than the path. This is a minor security issue
3876 * because articles can be created such that they are hard to view or edit.
3878 * In some rare cases you may wish to remove + for compatibility with old links.
3880 * Theoretically 0x80-0x9F of ISO 8859-1 should be disallowed, but
3881 * this breaks interlanguage links
3883 $wgLegalTitleChars = " %!\"$&'()*,\\-.\\/0-9:;=?@A-Z\\\\^_`a-z~\\x80-\\xFF+";
3886 * The interwiki prefix of the current wiki, or false if it doesn't have one.
3888 * @deprecated since 1.23; use $wgLocalInterwikis instead
3890 $wgLocalInterwiki = false;
3893 * Array for multiple $wgLocalInterwiki values, in case there are several
3894 * interwiki prefixes that point to the current wiki. If $wgLocalInterwiki is
3895 * set, its value is prepended to this array, for backwards compatibility.
3897 * Note, recent changes feeds use only the first entry in this array (or
3898 * $wgLocalInterwiki, if it is set). See $wgRCFeeds
3900 $wgLocalInterwikis = [];
3903 * Expiry time for cache of interwiki table
3905 $wgInterwikiExpiry = 10800;
3908 * @name Interwiki caching settings.
3913 * Interwiki cache, either as an associative array or a path to a constant
3914 * database (.cdb) file.
3916 * This data structure database is generated by the `dumpInterwiki` maintenance
3917 * script (which lives in the WikimediaMaintenance repository) and has key
3918 * formats such as the following:
3920 * - dbname:key - a simple key (e.g. enwiki:meta)
3921 * - _sitename:key - site-scope key (e.g. wiktionary:meta)
3922 * - __global:key - global-scope key (e.g. __global:meta)
3923 * - __sites:dbname - site mapping (e.g. __sites:enwiki)
3925 * Sites mapping just specifies site name, other keys provide "local url"
3928 * @var bool|array|string
3930 $wgInterwikiCache = false;
3933 * Specify number of domains to check for messages.
3934 * - 1: Just wiki(db)-level
3935 * - 2: wiki and global levels
3938 $wgInterwikiScopes = 3;
3941 * Fallback site, if unable to resolve from cache
3943 $wgInterwikiFallbackSite = 'wiki';
3945 /** @} */ # end of Interwiki caching settings.
3948 * @name SiteStore caching settings.
3953 * Specify the file location for the Sites json cache file.
3955 $wgSitesCacheFile = false;
3957 /** @} */ # end of SiteStore caching settings.
3960 * If local interwikis are set up which allow redirects,
3961 * set this regexp to restrict URLs which will be displayed
3962 * as 'redirected from' links.
3965 * It might look something like this:
3967 * $wgRedirectSources = '!^https?://[a-z-]+\.wikipedia\.org/!';
3970 * Leave at false to avoid displaying any incoming redirect markers.
3971 * This does not affect intra-wiki redirects, which don't change
3974 $wgRedirectSources = false;
3977 * Set this to false to avoid forcing the first letter of links to capitals.
3979 * @warning may break links! This makes links COMPLETELY case-sensitive. Links
3980 * appearing with a capital at the beginning of a sentence will *not* go to the
3981 * same place as links in the middle of a sentence using a lowercase initial.
3983 $wgCapitalLinks = true;
3986 * @since 1.16 - This can now be set per-namespace. Some special namespaces (such
3987 * as Special, see MWNamespace::$alwaysCapitalizedNamespaces for the full list) must be
3988 * true by default (and setting them has no effect), due to various things that
3989 * require them to be so. Also, since Talk namespaces need to directly mirror their
3990 * associated content namespaces, the values for those are ignored in favor of the
3991 * subject namespace's setting. Setting for NS_MEDIA is taken automatically from
3996 * $wgCapitalLinkOverrides[ NS_FILE ] = false;
3999 $wgCapitalLinkOverrides = [];
4002 * Which namespaces should support subpages?
4003 * See Language.php for a list of namespaces.
4005 $wgNamespacesWithSubpages = [
4008 NS_USER_TALK
=> true,
4010 NS_PROJECT_TALK
=> true,
4011 NS_FILE_TALK
=> true,
4012 NS_MEDIAWIKI
=> true,
4013 NS_MEDIAWIKI_TALK
=> true,
4014 NS_TEMPLATE_TALK
=> true,
4016 NS_HELP_TALK
=> true,
4017 NS_CATEGORY_TALK
=> true
4021 * Array holding default tracking category names.
4023 * Array contains the system messages for each tracking category.
4024 * Tracking categories allow pages with certain characteristics to be tracked.
4025 * It works by adding any such page to a category automatically.
4027 * A message with the suffix '-desc' should be added as a description message
4028 * to have extra information on Special:TrackingCategories.
4030 * @deprecated since 1.25 Extensions should now register tracking categories using
4031 * the new extension registration system.
4035 $wgTrackingCategories = [];
4038 * Array of namespaces which can be deemed to contain valid "content", as far
4039 * as the site statistics are concerned. Useful if additional namespaces also
4040 * contain "content" which should be considered when generating a count of the
4041 * number of articles in the wiki.
4043 $wgContentNamespaces = [ NS_MAIN
];
4046 * Array of namespaces, in addition to the talk namespaces, where signatures
4047 * (~~~~) are likely to be used. This determines whether to display the
4048 * Signature button on the edit toolbar, and may also be used by extensions.
4049 * For example, "traditional" style wikis, where content and discussion are
4050 * intermixed, could place NS_MAIN and NS_PROJECT namespaces in this array.
4052 $wgExtraSignatureNamespaces = [];
4055 * Max number of redirects to follow when resolving redirects.
4056 * 1 means only the first redirect is followed (default behavior).
4057 * 0 or less means no redirects are followed.
4059 $wgMaxRedirects = 1;
4062 * Array of invalid page redirect targets.
4063 * Attempting to create a redirect to any of the pages in this array
4064 * will make the redirect fail.
4065 * Userlogout is hard-coded, so it does not need to be listed here.
4066 * (bug 10569) Disallow Mypage and Mytalk as well.
4068 * As of now, this only checks special pages. Redirects to pages in
4069 * other namespaces cannot be invalidated by this variable.
4071 $wgInvalidRedirectTargets = [ 'Filepath', 'Mypage', 'Mytalk', 'Redirect' ];
4073 /** @} */ # End of title and interwiki settings }
4075 /************************************************************************//**
4076 * @name Parser settings
4077 * These settings configure the transformation from wikitext to HTML.
4082 * Parser configuration. Associative array with the following members:
4084 * class The class name
4086 * preprocessorClass The preprocessor class. Two classes are currently available:
4087 * Preprocessor_Hash, which uses plain PHP arrays for temporary
4088 * storage, and Preprocessor_DOM, which uses the DOM module for
4089 * temporary storage. Preprocessor_DOM generally uses less memory;
4090 * the speed of the two is roughly the same.
4092 * If this parameter is not given, it uses Preprocessor_DOM if the
4093 * DOM module is available, otherwise it uses Preprocessor_Hash.
4095 * The entire associative array will be passed through to the constructor as
4096 * the first parameter. Note that only Setup.php can use this variable --
4097 * the configuration will change at runtime via $wgParser member functions, so
4098 * the contents of this variable will be out-of-date. The variable can only be
4099 * changed during LocalSettings.php, in particular, it can't be changed during
4100 * an extension setup function.
4103 'class' => 'Parser',
4104 # 'preprocessorClass' => 'Preprocessor_Hash',
4108 * Maximum indent level of toc.
4110 $wgMaxTocLevel = 999;
4113 * A complexity limit on template expansion: the maximum number of nodes visited
4114 * by PPFrame::expand()
4116 $wgMaxPPNodeCount = 1000000;
4119 * A complexity limit on template expansion: the maximum number of elements
4120 * generated by Preprocessor::preprocessToObj(). This allows you to limit the
4121 * amount of memory used by the Preprocessor_DOM node cache: testing indicates
4122 * that each element uses about 160 bytes of memory on a 64-bit processor, so
4123 * this default corresponds to about 155 MB.
4125 * When the limit is exceeded, an exception is thrown.
4127 $wgMaxGeneratedPPNodeCount = 1000000;
4130 * Maximum recursion depth for templates within templates.
4131 * The current parser adds two levels to the PHP call stack for each template,
4132 * and xdebug limits the call stack to 100 by default. So this should hopefully
4133 * stop the parser before it hits the xdebug limit.
4135 $wgMaxTemplateDepth = 40;
4138 * @see $wgMaxTemplateDepth
4140 $wgMaxPPExpandDepth = 40;
4143 * URL schemes that should be recognized as valid by wfParseUrl().
4145 * WARNING: Do not add 'file:' to this or internal file links will be broken.
4146 * Instead, if you want to support file links, add 'file://'. The same applies
4147 * to any other protocols with the same name as a namespace. See bug #44011 for
4153 'bitcoin:', 'ftp://', 'ftps://', 'geo:', 'git://', 'gopher://', 'http://',
4154 'https://', 'irc://', 'ircs://', 'magnet:', 'mailto:', 'mms://', 'news:',
4155 'nntp://', 'redis://', 'sftp://', 'sip:', 'sips:', 'sms:', 'ssh://',
4156 'svn://', 'tel:', 'telnet://', 'urn:', 'worldwind://', 'xmpp:', '//'
4160 * If true, removes (by substituting) templates in signatures.
4162 $wgCleanSignatures = true;
4165 * Whether to allow inline image pointing to other websites
4167 $wgAllowExternalImages = false;
4170 * If the above is false, you can specify an exception here. Image URLs
4171 * that start with this string are then rendered, while all others are not.
4172 * You can use this to set up a trusted, simple repository of images.
4173 * You may also specify an array of strings to allow multiple sites
4177 * $wgAllowExternalImagesFrom = 'http://127.0.0.1/';
4178 * $wgAllowExternalImagesFrom = [ 'http://127.0.0.1/', 'http://example.com' ];
4181 $wgAllowExternalImagesFrom = '';
4184 * If $wgAllowExternalImages is false, you can allow an on-wiki
4185 * whitelist of regular expression fragments to match the image URL
4186 * against. If the image matches one of the regular expression fragments,
4187 * The image will be displayed.
4189 * Set this to true to enable the on-wiki whitelist (MediaWiki:External image whitelist)
4190 * Or false to disable it
4192 $wgEnableImageWhitelist = true;
4195 * A different approach to the above: simply allow the "<img>" tag to be used.
4196 * This allows you to specify alt text and other attributes, copy-paste HTML to
4197 * your wiki more easily, etc. However, allowing external images in any manner
4198 * will allow anyone with editing rights to snoop on your visitors' IP
4199 * addresses and so forth, if they wanted to, by inserting links to images on
4200 * sites they control.
4202 $wgAllowImageTag = false;
4205 * Configuration for HTML postprocessing tool. Set this to a configuration
4206 * array to enable an external tool. Dave Raggett's "HTML Tidy" is typically
4207 * used. See http://www.w3.org/People/Raggett/tidy/
4209 * If this is null and $wgUseTidy is true, the deprecated configuration
4210 * parameters will be used instead.
4212 * If this is null and $wgUseTidy is false, a pure PHP fallback will be used.
4216 * - RaggettInternalHHVM: Use the limited-functionality HHVM extension
4217 * - RaggettInternalPHP: Use the PECL extension
4218 * - RaggettExternal: Shell out to an external binary (tidyBin)
4220 * - tidyConfigFile: Path to configuration file for any of the Raggett drivers
4221 * - debugComment: True to add a comment to the output with warning messages
4222 * - tidyBin: For RaggettExternal, the path to the tidy binary.
4223 * - tidyCommandLine: For RaggettExternal, additional command line options.
4225 $wgTidyConfig = null;
4228 * Set this to true to use the deprecated tidy configuration parameters.
4229 * @deprecated use $wgTidyConfig
4234 * The path to the tidy binary.
4235 * @deprecated Use $wgTidyConfig['tidyBin']
4237 $wgTidyBin = 'tidy';
4240 * The path to the tidy config file
4241 * @deprecated Use $wgTidyConfig['tidyConfigFile']
4243 $wgTidyConf = $IP . '/includes/tidy/tidy.conf';
4246 * The command line options to the tidy binary
4247 * @deprecated Use $wgTidyConfig['tidyCommandLine']
4252 * Set this to true to use the tidy extension
4253 * @deprecated Use $wgTidyConfig['driver']
4255 $wgTidyInternal = extension_loaded( 'tidy' );
4258 * Put tidy warnings in HTML comments
4259 * Only works for internal tidy.
4261 $wgDebugTidy = false;
4264 * Allow raw, unchecked HTML in "<html>...</html>" sections.
4265 * THIS IS VERY DANGEROUS on a publicly editable site, so USE wgGroupPermissions
4266 * TO RESTRICT EDITING to only those that you trust
4271 * Set a default target for external links, e.g. _blank to pop up a new window.
4273 * This will also set the "noreferrer" and "noopener" link rel to prevent the
4274 * attack described at https://mathiasbynens.github.io/rel-noopener/ .
4275 * Some older browsers may not support these link attributes, hence
4276 * setting $wgExternalLinkTarget to _blank may represent a security risk
4277 * to some of your users.
4279 $wgExternalLinkTarget = false;
4282 * If true, external URL links in wiki text will be given the
4283 * rel="nofollow" attribute as a hint to search engines that
4284 * they should not be followed for ranking purposes as they
4285 * are user-supplied and thus subject to spamming.
4287 $wgNoFollowLinks = true;
4290 * Namespaces in which $wgNoFollowLinks doesn't apply.
4291 * See Language.php for a list of namespaces.
4293 $wgNoFollowNsExceptions = [];
4296 * If this is set to an array of domains, external links to these domain names
4297 * (or any subdomains) will not be set to rel="nofollow" regardless of the
4298 * value of $wgNoFollowLinks. For instance:
4300 * $wgNoFollowDomainExceptions = [ 'en.wikipedia.org', 'wiktionary.org', 'mediawiki.org' ];
4302 * This would add rel="nofollow" to links to de.wikipedia.org, but not
4303 * en.wikipedia.org, wiktionary.org, en.wiktionary.org, us.en.wikipedia.org,
4306 * Defaults to mediawiki.org for the links included in the software by default.
4308 $wgNoFollowDomainExceptions = [ 'mediawiki.org' ];
4311 * Allow DISPLAYTITLE to change title display
4313 $wgAllowDisplayTitle = true;
4316 * For consistency, restrict DISPLAYTITLE to text that normalizes to the same
4317 * canonical DB key. Also disallow some inline CSS rules like display: none;
4318 * which can cause the text to be hidden or unselectable.
4320 $wgRestrictDisplayTitle = true;
4323 * Maximum number of calls per parse to expensive parser functions such as
4326 $wgExpensiveParserFunctionLimit = 100;
4329 * Preprocessor caching threshold
4330 * Setting it to 'false' will disable the preprocessor cache.
4332 $wgPreprocessorCacheThreshold = 1000;
4335 * Enable interwiki transcluding. Only when iw_trans=1 in the interwiki table.
4337 $wgEnableScaryTranscluding = false;
4340 * Expiry time for transcluded templates cached in transcache database table.
4341 * Only used $wgEnableInterwikiTranscluding is set to true.
4343 $wgTranscludeCacheExpiry = 3600;
4345 /** @} */ # end of parser settings }
4347 /************************************************************************//**
4353 * Method used to determine if a page in a content namespace should be counted
4354 * as a valid article.
4356 * Redirect pages will never be counted as valid articles.
4358 * This variable can have the following values:
4359 * - 'any': all pages as considered as valid articles
4360 * - 'comma': the page must contain a comma to be considered valid
4361 * - 'link': the page must contain a [[wiki link]] to be considered valid
4363 * See also See https://www.mediawiki.org/wiki/Manual:Article_count
4365 * Retroactively changing this variable will not affect the existing count,
4366 * to update it, you will need to run the maintenance/updateArticleCount.php
4369 $wgArticleCountMethod = 'link';
4372 * How many days user must be idle before he is considered inactive. Will affect
4373 * the number shown on Special:Statistics, Special:ActiveUsers, and the
4374 * {{NUMBEROFACTIVEUSERS}} magic word in wikitext.
4375 * You might want to leave this as the default value, to provide comparable
4376 * numbers between different wikis.
4378 $wgActiveUserDays = 30;
4380 /** @} */ # End of statistics }
4382 /************************************************************************//**
4383 * @name User accounts, authentication
4388 * Central ID lookup providers
4389 * Key is the provider ID, value is a specification for ObjectFactory
4392 $wgCentralIdLookupProviders = [
4393 'local' => [ 'class' => 'LocalIdLookup' ],
4397 * Central ID lookup provider to use by default
4400 $wgCentralIdLookupProvider = 'local';
4403 * Password policy for local wiki users. A user's effective policy
4404 * is the superset of all policy statements from the policies for the
4405 * groups where the user is a member. If more than one group policy
4406 * include the same policy statement, the value is the max() of the
4407 * values. Note true > false. The 'default' policy group is required,
4408 * and serves as the minimum policy for all users. New statements can
4409 * be added by appending to $wgPasswordPolicy['checks'].
4411 * - MinimalPasswordLength - minimum length a user can set
4412 * - MinimumPasswordLengthToLogin - passwords shorter than this will
4413 * not be allowed to login, regardless if it is correct.
4414 * - MaximalPasswordLength - maximum length password a user is allowed
4415 * to attempt. Prevents DoS attacks with pbkdf2.
4416 * - PasswordCannotMatchUsername - Password cannot match username to
4417 * - PasswordCannotMatchBlacklist - Username/password combination cannot
4418 * match a specific, hardcoded blacklist.
4419 * - PasswordCannotBePopular - Blacklist passwords which are known to be
4420 * commonly chosen. Set to integer n to ban the top n passwords.
4421 * If you want to ban all common passwords on file, use the
4422 * PHP_INT_MAX constant.
4425 $wgPasswordPolicy = [
4428 'MinimalPasswordLength' => 8,
4429 'MinimumPasswordLengthToLogin' => 1,
4430 'PasswordCannotMatchUsername' => true,
4431 'PasswordCannotBePopular' => 25,
4434 'MinimalPasswordLength' => 8,
4435 'MinimumPasswordLengthToLogin' => 1,
4436 'PasswordCannotMatchUsername' => true,
4437 'PasswordCannotBePopular' => 25,
4440 'MinimalPasswordLength' => 8,
4441 'MinimumPasswordLengthToLogin' => 1,
4442 'PasswordCannotMatchUsername' => true,
4445 'MinimalPasswordLength' => 1,
4446 'PasswordCannotMatchUsername' => true,
4447 'PasswordCannotMatchBlacklist' => true,
4448 'MaximalPasswordLength' => 4096,
4452 'MinimalPasswordLength' => 'PasswordPolicyChecks::checkMinimalPasswordLength',
4453 'MinimumPasswordLengthToLogin' => 'PasswordPolicyChecks::checkMinimumPasswordLengthToLogin',
4454 'PasswordCannotMatchUsername' => 'PasswordPolicyChecks::checkPasswordCannotMatchUsername',
4455 'PasswordCannotMatchBlacklist' => 'PasswordPolicyChecks::checkPasswordCannotMatchBlacklist',
4456 'MaximalPasswordLength' => 'PasswordPolicyChecks::checkMaximalPasswordLength',
4457 'PasswordCannotBePopular' => 'PasswordPolicyChecks::checkPopularPasswordBlacklist'
4462 * Disable AuthManager
4464 * @deprecated since 1.27, for use during development only
4466 $wgDisableAuthManager = false;
4469 * Configure AuthManager
4471 * All providers are constructed using ObjectFactory, see that for the general
4472 * structure. The array may also contain a key "sort" used to order providers:
4473 * providers are stably sorted by this value, which should be an integer
4477 * - preauth: Array (keys ignored) of specifications for PreAuthenticationProviders
4478 * - primaryauth: Array (keys ignored) of specifications for PrimaryAuthenticationProviders
4479 * - secondaryauth: Array (keys ignored) of specifications for SecondaryAuthenticationProviders
4482 * @note If this is null or empty, the value from $wgAuthManagerAutoConfig is
4483 * used instead. Local customization should generally set this variable from
4484 * scratch to the desired configuration. Extensions that want to
4485 * auto-configure themselves should use $wgAuthManagerAutoConfig instead.
4487 $wgAuthManagerConfig = null;
4490 * @see $wgAuthManagerConfig
4493 $wgAuthManagerAutoConfig = [
4495 MediaWiki\Auth\LegacyHookPreAuthenticationProvider
::class => [
4496 'class' => MediaWiki\Auth\LegacyHookPreAuthenticationProvider
::class,
4499 MediaWiki\Auth\ThrottlePreAuthenticationProvider
::class => [
4500 'class' => MediaWiki\Auth\ThrottlePreAuthenticationProvider
::class,
4505 // TemporaryPasswordPrimaryAuthenticationProvider should come before
4506 // any other PasswordAuthenticationRequest-based
4507 // PrimaryAuthenticationProvider (or at least any that might return
4508 // FAIL rather than ABSTAIN for a wrong password), or password reset
4509 // won't work right. Do not remove this (or change the key) or
4510 // auto-configuration of other such providers in extensions will
4511 // probably auto-insert themselves in the wrong place.
4512 MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider
::class => [
4513 'class' => MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider
::class,
4515 // Fall through to LocalPasswordPrimaryAuthenticationProvider
4516 'authoritative' => false,
4520 MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider
::class => [
4521 'class' => MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider
::class,
4523 // Last one should be authoritative, or else the user will get
4524 // a less-than-helpful error message (something like "supplied
4525 // authentication info not supported" rather than "wrong
4526 // password") if it too fails.
4527 'authoritative' => true,
4532 'secondaryauth' => [
4533 MediaWiki\Auth\CheckBlocksSecondaryAuthenticationProvider
::class => [
4534 'class' => MediaWiki\Auth\CheckBlocksSecondaryAuthenticationProvider
::class,
4537 MediaWiki\Auth\ResetPasswordSecondaryAuthenticationProvider
::class => [
4538 'class' => MediaWiki\Auth\ResetPasswordSecondaryAuthenticationProvider
::class,
4541 // Linking during login is experimental, enable at your own risk - T134952
4542 // MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider::class => [
4543 // 'class' => MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider::class,
4546 MediaWiki\Auth\EmailNotificationSecondaryAuthenticationProvider
::class => [
4547 'class' => MediaWiki\Auth\EmailNotificationSecondaryAuthenticationProvider
::class,
4554 * Time frame for re-authentication.
4556 * With only password-based authentication, you'd just ask the user to re-enter
4557 * their password to verify certain operations like changing the password or
4558 * changing the account's email address. But under AuthManager, the user might
4559 * not have a password (you might even have to redirect the browser to a
4560 * third-party service or something complex like that), you might want to have
4561 * both factors of a two-factor authentication, and so on. So, the options are:
4562 * - Incorporate the whole multi-step authentication flow within everything
4563 * that needs to do this.
4564 * - Consider it good if they used Special:UserLogin during this session within
4565 * the last X seconds.
4566 * - Come up with a third option.
4568 * MediaWiki currently takes the second option. This setting configures the
4571 * This allows for configuring different time frames for different
4572 * "operations". The operations used in MediaWiki core include:
4575 * - ChangeCredentials
4576 * - RemoveCredentials
4579 * Additional operations may be used by extensions, either explicitly by
4580 * calling AuthManager::securitySensitiveOperationStatus(),
4581 * ApiAuthManagerHelper::securitySensitiveOperation() or
4582 * SpecialPage::checkLoginSecurityLevel(), or implicitly by overriding
4583 * SpecialPage::getLoginSecurityLevel() or by subclassing
4584 * AuthManagerSpecialPage.
4586 * The key 'default' is used if a requested operation isn't defined in the array.
4589 * @var int[] operation => time in seconds. A 'default' key must always be provided.
4591 $wgReauthenticateTime = [
4596 * Whether to allow security-sensitive operations when re-authentication is not possible.
4598 * If AuthManager::canAuthenticateNow() is false (e.g. the current
4599 * SessionProvider is not able to change users, such as when OAuth is in use),
4600 * AuthManager::securitySensitiveOperationStatus() cannot sensibly return
4601 * SEC_REAUTH. Setting an operation true here will have it return SEC_OK in
4602 * that case, while setting it false will have it return SEC_FAIL.
4604 * The key 'default' is used if a requested operation isn't defined in the array.
4607 * @see $wgReauthenticateTime
4608 * @var bool[] operation => boolean. A 'default' key must always be provided.
4610 $wgAllowSecuritySensitiveOperationIfCannotReauthenticate = [
4615 * List of AuthenticationRequest class names which are not changeable through
4616 * Special:ChangeCredentials and the changeauthenticationdata API.
4617 * This is only enforced on the client level; AuthManager itself (e.g.
4618 * AuthManager::allowsAuthenticationDataChange calls) is not affected.
4619 * Class names are checked for exact match (not for subclasses).
4623 $wgChangeCredentialsBlacklist = [
4624 \MediaWiki\Auth\TemporaryPasswordAuthenticationRequest
::class
4628 * List of AuthenticationRequest class names which are not removable through
4629 * Special:RemoveCredentials and the removeauthenticationdata API.
4630 * This is only enforced on the client level; AuthManager itself (e.g.
4631 * AuthManager::allowsAuthenticationDataChange calls) is not affected.
4632 * Class names are checked for exact match (not for subclasses).
4636 $wgRemoveCredentialsBlacklist = [
4637 \MediaWiki\Auth\PasswordAuthenticationRequest
::class,
4641 * For compatibility with old installations set to false
4642 * @deprecated since 1.24 will be removed in future
4644 $wgPasswordSalt = true;
4647 * Specifies the minimal length of a user password. If set to 0, empty pass-
4648 * words are allowed.
4649 * @deprecated since 1.26, use $wgPasswordPolicy's MinimalPasswordLength.
4651 $wgMinimalPasswordLength = false;
4654 * Specifies the maximal length of a user password (T64685).
4656 * It is not recommended to make this greater than the default, as it can
4657 * allow DoS attacks by users setting really long passwords. In addition,
4658 * this should not be lowered too much, as it enforces weak passwords.
4660 * @warning Unlike other password settings, user with passwords greater than
4661 * the maximum will not be able to log in.
4662 * @deprecated since 1.26, use $wgPasswordPolicy's MaximalPasswordLength.
4664 $wgMaximalPasswordLength = false;
4667 * Specifies if users should be sent to a password-reset form on login, if their
4668 * password doesn't meet the requirements of User::isValidPassword().
4671 $wgInvalidPasswordReset = true;
4674 * Default password type to use when hashing user passwords
4678 $wgPasswordDefault = 'pbkdf2';
4681 * Configuration for built-in password types. Maps the password type
4682 * to an array of options. The 'class' option is the Password class to
4683 * use. All other options are class-dependent.
4685 * An advanced example:
4687 * $wgPasswordConfig['bcrypt-peppered'] = [
4688 * 'class' => 'EncryptedPassword',
4689 * 'underlying' => 'bcrypt',
4691 * 'cipher' => MCRYPT_RIJNDAEL_256,
4692 * 'mode' => MCRYPT_MODE_CBC,
4699 $wgPasswordConfig = [
4701 'class' => 'MWOldPassword',
4704 'class' => 'MWSaltedPassword',
4706 'pbkdf2-legacyA' => [
4707 'class' => 'LayeredParameterizedPassword',
4713 'pbkdf2-legacyB' => [
4714 'class' => 'LayeredParameterizedPassword',
4721 'class' => 'BcryptPassword',
4725 'class' => 'Pbkdf2Password',
4733 * Whether to allow password resets ("enter some identifying data, and we'll send an email
4734 * with a temporary password you can use to get back into the account") identified by
4735 * various bits of data. Setting all of these to false (or the whole variable to false)
4736 * has the effect of disabling password resets entirely
4738 $wgPasswordResetRoutes = [
4744 * Maximum number of Unicode characters in signature
4746 $wgMaxSigChars = 255;
4749 * Maximum number of bytes in username. You want to run the maintenance
4750 * script ./maintenance/checkUsernames.php once you have changed this value.
4752 $wgMaxNameChars = 255;
4755 * Array of usernames which may not be registered or logged in from
4756 * Maintenance scripts can still use these
4758 $wgReservedUsernames = [
4759 'MediaWiki default', // Default 'Main Page' and MediaWiki: message pages
4760 'Conversion script', // Used for the old Wikipedia software upgrade
4761 'Maintenance script', // Maintenance scripts which perform editing, image import script
4762 'Template namespace initialisation script', // Used in 1.2->1.3 upgrade
4763 'ScriptImporter', // Default user name used by maintenance/importSiteScripts.php
4764 'msg:double-redirect-fixer', // Automatic double redirect fix
4765 'msg:usermessage-editor', // Default user for leaving user messages
4766 'msg:proxyblocker', // For $wgProxyList and Special:Blockme (removed in 1.22)
4767 'msg:spambot_username', // Used by cleanupSpam.php
4768 'msg:autochange-username', // Used by anon category RC entries (parser functions, Lua & purges)
4772 * Settings added to this array will override the default globals for the user
4773 * preferences used by anonymous visitors and newly created accounts.
4774 * For instance, to disable editing on double clicks:
4775 * $wgDefaultUserOptions ['editondblclick'] = 0;
4777 $wgDefaultUserOptions = [
4778 'ccmeonemails' => 0,
4780 'date' => 'default',
4783 'editfont' => 'default',
4784 'editondblclick' => 0,
4785 'editsectiononrightclick' => 0,
4786 'enotifminoredits' => 0,
4787 'enotifrevealaddr' => 0,
4788 'enotifusertalkpages' => 1,
4789 'enotifwatchlistpages' => 1,
4790 'extendwatchlist' => 1,
4792 'forceeditsummary' => 0,
4793 'gender' => 'unknown',
4795 'hidepatrolled' => 0,
4796 'hidecategorization' => 1,
4799 'minordefault' => 0,
4800 'newpageshidepatrolled' => 0,
4802 'norollbackdiff' => 0,
4803 'numberheadings' => 0,
4804 'previewonfirst' => 0,
4805 'previewontop' => 1,
4809 'showhiddencats' => 0,
4810 'shownumberswatching' => 1,
4813 'stubthreshold' => 0,
4816 'uselivepreview' => 0,
4818 'watchcreations' => 1,
4819 'watchdefault' => 1,
4820 'watchdeletion' => 0,
4821 'watchuploads' => 1,
4822 'watchlistdays' => 3.0,
4823 'watchlisthideanons' => 0,
4824 'watchlisthidebots' => 0,
4825 'watchlisthideliu' => 0,
4826 'watchlisthideminor' => 0,
4827 'watchlisthideown' => 0,
4828 'watchlisthidepatrolled' => 0,
4829 'watchlisthidecategorization' => 1,
4830 'watchlistreloadautomatically' => 0,
4832 'watchrollback' => 0,
4834 'useeditwarning' => 1,
4835 'prefershttps' => 1,
4839 * An array of preferences to not show for the user
4841 $wgHiddenPrefs = [];
4844 * Characters to prevent during new account creations.
4845 * This is used in a regular expression character class during
4846 * registration (regex metacharacters like / are escaped).
4848 $wgInvalidUsernameCharacters = '@:';
4851 * Character used as a delimiter when testing for interwiki userrights
4852 * (In Special:UserRights, it is possible to modify users on different
4853 * databases if the delimiter is used, e.g. "Someuser@enwiki").
4855 * It is recommended that you have this delimiter in
4856 * $wgInvalidUsernameCharacters above, or you will not be able to
4857 * modify the user rights of those users via Special:UserRights
4859 $wgUserrightsInterwikiDelimiter = '@';
4862 * This is to let user authenticate using https when they come from http.
4863 * Based on an idea by George Herbert on wikitech-l:
4864 * https://lists.wikimedia.org/pipermail/wikitech-l/2010-October/050039.html
4867 $wgSecureLogin = false;
4870 * Versioning for authentication tokens.
4872 * If non-null, this is combined with the user's secret (the user_token field
4873 * in the DB) to generate the token cookie. Changing this will invalidate all
4874 * active sessions (i.e. it will log everyone out).
4879 $wgAuthenticationTokenVersion = null;
4882 * MediaWiki\Session\SessionProvider configuration.
4884 * Value is an array of ObjectFactory specifications for the SessionProviders
4885 * to be used. Keys in the array are ignored. Order is not significant.
4889 $wgSessionProviders = [
4890 MediaWiki\Session\CookieSessionProvider
::class => [
4891 'class' => MediaWiki\Session\CookieSessionProvider
::class,
4894 'callUserSetCookiesHook' => true,
4897 MediaWiki\Session\BotPasswordSessionProvider
::class => [
4898 'class' => MediaWiki\Session\BotPasswordSessionProvider
::class,
4905 /** @} */ # end user accounts }
4907 /************************************************************************//**
4908 * @name User rights, access control and monitoring
4913 * Number of seconds before autoblock entries expire. Default 86400 = 1 day.
4915 $wgAutoblockExpiry = 86400;
4918 * Set this to true to allow blocked users to edit their own user talk page.
4920 $wgBlockAllowsUTEdit = true;
4923 * Allow sysops to ban users from accessing Emailuser
4925 $wgSysopEmailBans = true;
4928 * Limits on the possible sizes of range blocks.
4930 * CIDR notation is hard to understand, it's easy to mistakenly assume that a
4931 * /1 is a small range and a /31 is a large range. For IPv4, setting a limit of
4932 * half the number of bits avoids such errors, and allows entire ISPs to be
4933 * blocked using a small number of range blocks.
4935 * For IPv6, RFC 3177 recommends that a /48 be allocated to every residential
4936 * customer, so range blocks larger than /64 (half the number of bits) will
4937 * plainly be required. RFC 4692 implies that a very large ISP may be
4938 * allocated a /19 if a generous HD-Ratio of 0.8 is used, so we will use that
4939 * as our limit. As of 2012, blocking the whole world would require a /4 range.
4941 $wgBlockCIDRLimit = [
4942 'IPv4' => 16, # Blocks larger than a /16 (64k addresses) will not be allowed
4947 * If true, blocked users will not be allowed to login. When using this with
4948 * a public wiki, the effect of logging out blocked users may actually be
4949 * avers: unless the user's address is also blocked (e.g. auto-block),
4950 * logging the user out will again allow reading and editing, just as for
4951 * anonymous visitors.
4953 $wgBlockDisablesLogin = false;
4956 * Pages anonymous user may see, set as an array of pages titles.
4960 * $wgWhitelistRead = array ( "Main Page", "Wikipedia:Help");
4963 * Special:Userlogin and Special:ChangePassword are always whitelisted.
4965 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
4966 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
4968 * @note Also that this will only protect _pages in the wiki_. Uploaded files
4969 * will remain readable. You can use img_auth.php to protect uploaded files,
4970 * see https://www.mediawiki.org/wiki/Manual:Image_Authorization
4972 $wgWhitelistRead = false;
4975 * Pages anonymous user may see, set as an array of regular expressions.
4977 * This function will match the regexp against the title name, which
4978 * is without underscore.
4981 * To whitelist [[Main Page]]:
4983 * $wgWhitelistReadRegexp = [ "/Main Page/" ];
4986 * @note Unless ^ and/or $ is specified, a regular expression might match
4987 * pages not intended to be whitelisted. The above example will also
4988 * whitelist a page named 'Security Main Page'.
4991 * To allow reading any page starting with 'User' regardless of the case:
4993 * $wgWhitelistReadRegexp = [ "@^UsEr.*@i" ];
4995 * Will allow both [[User is banned]] and [[User:JohnDoe]]
4997 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
4998 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
5000 $wgWhitelistReadRegexp = false;
5003 * Should editors be required to have a validated e-mail
5004 * address before being allowed to edit?
5006 $wgEmailConfirmToEdit = false;
5009 * Should MediaWiki attempt to protect user's privacy when doing redirects?
5010 * Keep this true if access counts to articles are made public.
5012 $wgHideIdentifiableRedirects = true;
5015 * Permission keys given to users in each group.
5017 * This is an array where the keys are all groups and each value is an
5018 * array of the format (right => boolean).
5020 * The second format is used to support per-namespace permissions.
5021 * Note that this feature does not fully work for all permission types.
5023 * All users are implicitly in the '*' group including anonymous visitors;
5024 * logged-in users are all implicitly in the 'user' group. These will be
5025 * combined with the permissions of all groups that a given user is listed
5026 * in in the user_groups table.
5028 * Note: Don't set $wgGroupPermissions = []; unless you know what you're
5029 * doing! This will wipe all permissions, and may mean that your users are
5030 * unable to perform certain essential tasks or access new functionality
5031 * when new permissions are introduced and default grants established.
5033 * Functionality to make pages inaccessible has not been extensively tested
5034 * for security. Use at your own risk!
5036 * This replaces $wgWhitelistAccount and $wgWhitelistEdit
5038 $wgGroupPermissions = [];
5040 /** @cond file_level_code */
5041 // Implicit group for all visitors
5042 $wgGroupPermissions['*']['createaccount'] = true;
5043 $wgGroupPermissions['*']['read'] = true;
5044 $wgGroupPermissions['*']['edit'] = true;
5045 $wgGroupPermissions['*']['createpage'] = true;
5046 $wgGroupPermissions['*']['createtalk'] = true;
5047 $wgGroupPermissions['*']['writeapi'] = true;
5048 $wgGroupPermissions['*']['editmyusercss'] = true;
5049 $wgGroupPermissions['*']['editmyuserjs'] = true;
5050 $wgGroupPermissions['*']['viewmywatchlist'] = true;
5051 $wgGroupPermissions['*']['editmywatchlist'] = true;
5052 $wgGroupPermissions['*']['viewmyprivateinfo'] = true;
5053 $wgGroupPermissions['*']['editmyprivateinfo'] = true;
5054 $wgGroupPermissions['*']['editmyoptions'] = true;
5055 # $wgGroupPermissions['*']['patrolmarks'] = false; // let anons see what was patrolled
5057 // Implicit group for all logged-in accounts
5058 $wgGroupPermissions['user']['move'] = true;
5059 $wgGroupPermissions['user']['move-subpages'] = true;
5060 $wgGroupPermissions['user']['move-rootuserpages'] = true; // can move root userpages
5061 $wgGroupPermissions['user']['move-categorypages'] = true;
5062 $wgGroupPermissions['user']['movefile'] = true;
5063 $wgGroupPermissions['user']['read'] = true;
5064 $wgGroupPermissions['user']['edit'] = true;
5065 $wgGroupPermissions['user']['createpage'] = true;
5066 $wgGroupPermissions['user']['createtalk'] = true;
5067 $wgGroupPermissions['user']['writeapi'] = true;
5068 $wgGroupPermissions['user']['upload'] = true;
5069 $wgGroupPermissions['user']['reupload'] = true;
5070 $wgGroupPermissions['user']['reupload-shared'] = true;
5071 $wgGroupPermissions['user']['minoredit'] = true;
5072 $wgGroupPermissions['user']['purge'] = true; // can use ?action=purge without clicking "ok"
5073 $wgGroupPermissions['user']['sendemail'] = true;
5074 $wgGroupPermissions['user']['applychangetags'] = true;
5075 $wgGroupPermissions['user']['changetags'] = true;
5077 // Implicit group for accounts that pass $wgAutoConfirmAge
5078 $wgGroupPermissions['autoconfirmed']['autoconfirmed'] = true;
5079 $wgGroupPermissions['autoconfirmed']['editsemiprotected'] = true;
5081 // Users with bot privilege can have their edits hidden
5082 // from various log pages by default
5083 $wgGroupPermissions['bot']['bot'] = true;
5084 $wgGroupPermissions['bot']['autoconfirmed'] = true;
5085 $wgGroupPermissions['bot']['editsemiprotected'] = true;
5086 $wgGroupPermissions['bot']['nominornewtalk'] = true;
5087 $wgGroupPermissions['bot']['autopatrol'] = true;
5088 $wgGroupPermissions['bot']['suppressredirect'] = true;
5089 $wgGroupPermissions['bot']['apihighlimits'] = true;
5090 $wgGroupPermissions['bot']['writeapi'] = true;
5092 // Most extra permission abilities go to this group
5093 $wgGroupPermissions['sysop']['block'] = true;
5094 $wgGroupPermissions['sysop']['createaccount'] = true;
5095 $wgGroupPermissions['sysop']['delete'] = true;
5096 // can be separately configured for pages with > $wgDeleteRevisionsLimit revs
5097 $wgGroupPermissions['sysop']['bigdelete'] = true;
5098 // can view deleted history entries, but not see or restore the text
5099 $wgGroupPermissions['sysop']['deletedhistory'] = true;
5100 // can view deleted revision text
5101 $wgGroupPermissions['sysop']['deletedtext'] = true;
5102 $wgGroupPermissions['sysop']['undelete'] = true;
5103 $wgGroupPermissions['sysop']['editinterface'] = true;
5104 $wgGroupPermissions['sysop']['editusercss'] = true;
5105 $wgGroupPermissions['sysop']['edituserjs'] = true;
5106 $wgGroupPermissions['sysop']['editcontentmodel'] = true;
5107 $wgGroupPermissions['sysop']['import'] = true;
5108 $wgGroupPermissions['sysop']['importupload'] = true;
5109 $wgGroupPermissions['sysop']['move'] = true;
5110 $wgGroupPermissions['sysop']['move-subpages'] = true;
5111 $wgGroupPermissions['sysop']['move-rootuserpages'] = true;
5112 $wgGroupPermissions['sysop']['move-categorypages'] = true;
5113 $wgGroupPermissions['sysop']['patrol'] = true;
5114 $wgGroupPermissions['sysop']['autopatrol'] = true;
5115 $wgGroupPermissions['sysop']['protect'] = true;
5116 $wgGroupPermissions['sysop']['editprotected'] = true;
5117 $wgGroupPermissions['sysop']['rollback'] = true;
5118 $wgGroupPermissions['sysop']['upload'] = true;
5119 $wgGroupPermissions['sysop']['reupload'] = true;
5120 $wgGroupPermissions['sysop']['reupload-shared'] = true;
5121 $wgGroupPermissions['sysop']['unwatchedpages'] = true;
5122 $wgGroupPermissions['sysop']['autoconfirmed'] = true;
5123 $wgGroupPermissions['sysop']['editsemiprotected'] = true;
5124 $wgGroupPermissions['sysop']['ipblock-exempt'] = true;
5125 $wgGroupPermissions['sysop']['blockemail'] = true;
5126 $wgGroupPermissions['sysop']['markbotedits'] = true;
5127 $wgGroupPermissions['sysop']['apihighlimits'] = true;
5128 $wgGroupPermissions['sysop']['browsearchive'] = true;
5129 $wgGroupPermissions['sysop']['noratelimit'] = true;
5130 $wgGroupPermissions['sysop']['movefile'] = true;
5131 $wgGroupPermissions['sysop']['unblockself'] = true;
5132 $wgGroupPermissions['sysop']['suppressredirect'] = true;
5133 # $wgGroupPermissions['sysop']['pagelang'] = true;
5134 # $wgGroupPermissions['sysop']['upload_by_url'] = true;
5135 $wgGroupPermissions['sysop']['mergehistory'] = true;
5136 $wgGroupPermissions['sysop']['managechangetags'] = true;
5137 $wgGroupPermissions['sysop']['deletechangetags'] = true;
5139 // Permission to change users' group assignments
5140 $wgGroupPermissions['bureaucrat']['userrights'] = true;
5141 $wgGroupPermissions['bureaucrat']['noratelimit'] = true;
5142 // Permission to change users' groups assignments across wikis
5143 # $wgGroupPermissions['bureaucrat']['userrights-interwiki'] = true;
5144 // Permission to export pages including linked pages regardless of $wgExportMaxLinkDepth
5145 # $wgGroupPermissions['bureaucrat']['override-export-depth'] = true;
5147 # $wgGroupPermissions['sysop']['deletelogentry'] = true;
5148 # $wgGroupPermissions['sysop']['deleterevision'] = true;
5149 // To hide usernames from users and Sysops
5150 # $wgGroupPermissions['suppress']['hideuser'] = true;
5151 // To hide revisions/log items from users and Sysops
5152 # $wgGroupPermissions['suppress']['suppressrevision'] = true;
5153 // To view revisions/log items hidden from users and Sysops
5154 # $wgGroupPermissions['suppress']['viewsuppressed'] = true;
5155 // For private suppression log access
5156 # $wgGroupPermissions['suppress']['suppressionlog'] = true;
5159 * The developer group is deprecated, but can be activated if need be
5160 * to use the 'lockdb' and 'unlockdb' special pages. Those require
5161 * that a lock file be defined and creatable/removable by the web
5164 # $wgGroupPermissions['developer']['siteadmin'] = true;
5169 * Permission keys revoked from users in each group.
5171 * This acts the same way as wgGroupPermissions above, except that
5172 * if the user is in a group here, the permission will be removed from them.
5174 * Improperly setting this could mean that your users will be unable to perform
5175 * certain essential tasks, so use at your own risk!
5177 $wgRevokePermissions = [];
5180 * Implicit groups, aren't shown on Special:Listusers or somewhere else
5182 $wgImplicitGroups = [ '*', 'user', 'autoconfirmed' ];
5185 * A map of group names that the user is in, to group names that those users
5186 * are allowed to add or revoke.
5188 * Setting the list of groups to add or revoke to true is equivalent to "any
5192 * To allow sysops to add themselves to the "bot" group:
5194 * $wgGroupsAddToSelf = [ 'sysop' => [ 'bot' ] ];
5198 * Implicit groups may be used for the source group, for instance:
5200 * $wgGroupsRemoveFromSelf = [ '*' => true ];
5202 * This allows users in the '*' group (i.e. any user) to remove themselves from
5203 * any group that they happen to be in.
5205 $wgGroupsAddToSelf = [];
5208 * @see $wgGroupsAddToSelf
5210 $wgGroupsRemoveFromSelf = [];
5213 * Set of available actions that can be restricted via action=protect
5214 * You probably shouldn't change this.
5215 * Translated through restriction-* messages.
5216 * Title::getRestrictionTypes() will remove restrictions that are not
5217 * applicable to a specific title (create and upload)
5219 $wgRestrictionTypes = [ 'create', 'edit', 'move', 'upload' ];
5222 * Rights which can be required for each protection level (via action=protect)
5224 * You can add a new protection level that requires a specific
5225 * permission by manipulating this array. The ordering of elements
5226 * dictates the order on the protection form's lists.
5228 * - '' will be ignored (i.e. unprotected)
5229 * - 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility
5230 * - 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility
5232 $wgRestrictionLevels = [ '', 'autoconfirmed', 'sysop' ];
5235 * Restriction levels that can be used with cascading protection
5237 * A page can only be protected with cascading protection if the
5238 * requested restriction level is included in this array.
5240 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
5241 * 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility.
5243 $wgCascadingRestrictionLevels = [ 'sysop' ];
5246 * Restriction levels that should be considered "semiprotected"
5248 * Certain places in the interface recognize a dichotomy between "protected"
5249 * and "semiprotected", without further distinguishing the specific levels. In
5250 * general, if anyone can be eligible to edit a protection level merely by
5251 * reaching some condition in $wgAutopromote, it should probably be considered
5254 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
5255 * 'sysop' is not changed, since it really shouldn't be here.
5257 $wgSemiprotectedRestrictionLevels = [ 'autoconfirmed' ];
5260 * Set the minimum permissions required to edit pages in each
5261 * namespace. If you list more than one permission, a user must
5262 * have all of them to edit pages in that namespace.
5264 * @note NS_MEDIAWIKI is implicitly restricted to 'editinterface'.
5266 $wgNamespaceProtection = [];
5269 * Pages in namespaces in this array can not be used as templates.
5271 * Elements MUST be numeric namespace ids, you can safely use the MediaWiki
5272 * namespaces constants (NS_USER, NS_MAIN...).
5274 * Among other things, this may be useful to enforce read-restrictions
5275 * which may otherwise be bypassed by using the template mechanism.
5277 $wgNonincludableNamespaces = [];
5280 * Number of seconds an account is required to age before it's given the
5281 * implicit 'autoconfirm' group membership. This can be used to limit
5282 * privileges of new accounts.
5284 * Accounts created by earlier versions of the software may not have a
5285 * recorded creation date, and will always be considered to pass the age test.
5287 * When left at 0, all registered accounts will pass.
5290 * Set automatic confirmation to 10 minutes (which is 600 seconds):
5292 * $wgAutoConfirmAge = 600; // ten minutes
5294 * Set age to one day:
5296 * $wgAutoConfirmAge = 3600*24; // one day
5299 $wgAutoConfirmAge = 0;
5302 * Number of edits an account requires before it is autoconfirmed.
5303 * Passing both this AND the time requirement is needed. Example:
5307 * $wgAutoConfirmCount = 50;
5310 $wgAutoConfirmCount = 0;
5313 * Automatically add a usergroup to any user who matches certain conditions.
5315 * @todo Redocument $wgAutopromote
5318 * [ '&' or '|' or '^' or '!', cond1, cond2, ... ]
5319 * where cond1, cond2, ... are themselves conditions; *OR*
5320 * APCOND_EMAILCONFIRMED, *OR*
5321 * [ APCOND_EMAILCONFIRMED ], *OR*
5322 * [ APCOND_EDITCOUNT, number of edits ], *OR*
5323 * [ APCOND_AGE, seconds since registration ], *OR*
5324 * [ APCOND_INGROUPS, group1, group2, ... ], *OR*
5325 * [ APCOND_ISIP, ip ], *OR*
5326 * [ APCOND_IPINRANGE, range ], *OR*
5327 * [ APCOND_AGE_FROM_EDIT, seconds since first edit ], *OR*
5328 * [ APCOND_BLOCKED ], *OR*
5329 * [ APCOND_ISBOT ], *OR*
5330 * similar constructs defined by extensions.
5332 * If $wgEmailAuthentication is off, APCOND_EMAILCONFIRMED will be true for any
5333 * user who has provided an e-mail address.
5336 'autoconfirmed' => [ '&',
5337 [ APCOND_EDITCOUNT
, &$wgAutoConfirmCount ],
5338 [ APCOND_AGE
, &$wgAutoConfirmAge ],
5343 * Automatically add a usergroup to any user who matches certain conditions.
5345 * Does not add the user to the group again if it has been removed.
5346 * Also, does not remove the group if the user no longer meets the criteria.
5350 * [ event => criteria, ... ]
5352 * Where event is either:
5353 * - 'onEdit' (when user edits)
5355 * Criteria has the same format as $wgAutopromote
5357 * @see $wgAutopromote
5360 $wgAutopromoteOnce = [
5365 * Put user rights log entries for autopromotion in recent changes?
5368 $wgAutopromoteOnceLogInRC = true;
5371 * $wgAddGroups and $wgRemoveGroups can be used to give finer control over who
5372 * can assign which groups at Special:Userrights.
5375 * Bureaucrats can add any group:
5377 * $wgAddGroups['bureaucrat'] = true;
5379 * Bureaucrats can only remove bots and sysops:
5381 * $wgRemoveGroups['bureaucrat'] = [ 'bot', 'sysop' ];
5383 * Sysops can make bots:
5385 * $wgAddGroups['sysop'] = [ 'bot' ];
5387 * Sysops can disable other sysops in an emergency, and disable bots:
5389 * $wgRemoveGroups['sysop'] = [ 'sysop', 'bot' ];
5397 $wgRemoveGroups = [];
5400 * A list of available rights, in addition to the ones defined by the core.
5401 * For extensions only.
5403 $wgAvailableRights = [];
5406 * Optional to restrict deletion of pages with higher revision counts
5407 * to users with the 'bigdelete' permission. (Default given to sysops.)
5409 $wgDeleteRevisionsLimit = 0;
5412 * The maximum number of edits a user can have and
5413 * can still be hidden by users with the hideuser permission.
5414 * This is limited for performance reason.
5415 * Set to false to disable the limit.
5418 $wgHideUserContribLimit = 1000;
5421 * Number of accounts each IP address may create, 0 to disable.
5423 * @warning Requires $wgMainCacheType to be enabled
5425 $wgAccountCreationThrottle = 0;
5428 * Edits matching these regular expressions in body text
5429 * will be recognised as spam and rejected automatically.
5431 * There's no administrator override on-wiki, so be careful what you set. :)
5432 * May be an array of regexes or a single string for backwards compatibility.
5434 * @see https://en.wikipedia.org/wiki/Regular_expression
5436 * @note Each regex needs a beginning/end delimiter, eg: # or /
5441 * Same as the above except for edit summaries
5443 $wgSummarySpamRegex = [];
5446 * Whether to use DNS blacklists in $wgDnsBlacklistUrls to check for open
5450 $wgEnableDnsBlacklist = false;
5453 * List of DNS blacklists to use, if $wgEnableDnsBlacklist is true.
5455 * This is an array of either a URL or an array with the URL and a key (should
5456 * the blacklist require a key).
5460 * $wgDnsBlacklistUrls = [
5461 * // String containing URL
5462 * 'http.dnsbl.sorbs.net.',
5463 * // Array with URL and key, for services that require a key
5464 * [ 'dnsbl.httpbl.net.', 'mykey' ],
5465 * // Array with just the URL. While this works, it is recommended that you
5466 * // just use a string as shown above
5467 * [ 'opm.tornevall.org.' ]
5471 * @note You should end the domain name with a . to avoid searching your
5472 * eventual domain search suffixes.
5475 $wgDnsBlacklistUrls = [ 'http.dnsbl.sorbs.net.' ];
5478 * Proxy whitelist, list of addresses that are assumed to be non-proxy despite
5479 * what the other methods might say.
5481 $wgProxyWhitelist = [];
5484 * Whether to look at the X-Forwarded-For header's list of (potentially spoofed)
5485 * IPs and apply IP blocks to them. This allows for IP blocks to work with correctly-configured
5486 * (transparent) proxies without needing to block the proxies themselves.
5488 $wgApplyIpBlocksToXff = false;
5491 * Simple rate limiter options to brake edit floods.
5493 * Maximum number actions allowed in the given number of seconds; after that
5494 * the violating client receives HTTP 500 error pages until the period
5498 * To set a generic maximum of 4 hits in 60 seconds:
5500 * $wgRateLimits = [ 4, 60 ];
5504 * You could also limit per action and then type of users.
5508 * 'anon' => [ x, y ], // any and all anonymous edits (aggregate)
5509 * 'user' => [ x, y ], // each logged-in user
5510 * 'newbie' => [ x, y ], // each new autoconfirmed accounts; overrides 'user'
5511 * 'ip' => [ x, y ], // each anon and recent account
5512 * 'subnet' => [ x, y ], // ... within a /24 subnet in IPv4 or /64 in IPv6
5517 * @warning Requires that $wgMainCacheType is set to something persistent
5523 'newbie' => [ 8, 60 ],
5527 'newbie' => [ 2, 120 ],
5528 'user' => [ 8, 60 ],
5533 'newbie' => [ 8, 60 ],
5537 'user' => [ 10, 60 ],
5538 'newbie' => [ 5, 120 ]
5540 // Triggering password resets emails
5542 'ip' => [ 5, 3600 ],
5544 // Emailing other users using MediaWiki
5546 'ip' => [ 5, 86400 ],
5547 'newbie' => [ 5, 86400 ],
5548 'user' => [ 20, 86400 ],
5553 'user' => [ 30, 60 ],
5555 // Purges of link tables
5558 'user' => [ 30, 60 ],
5560 // Files rendered via thumb.php or thumb_handler.php
5562 'ip' => [ 700, 30 ],
5563 'user' => [ 700, 30 ],
5565 // Same as above but for non-standard thumbnails
5566 'renderfile-nonstandard' => [
5568 'user' => [ 70, 30 ],
5570 // Stashing edits into cache before save
5573 'newbie' => [ 30, 60 ],
5575 // Adding or removing change tags
5578 'newbie' => [ 8, 60 ],
5583 * Array of IPs which should be excluded from rate limits.
5584 * This may be useful for whitelisting NAT gateways for conferences, etc.
5586 $wgRateLimitsExcludedIPs = [];
5589 * Log IP addresses in the recentchanges table; can be accessed only by
5590 * extensions (e.g. CheckUser) or a DB admin
5591 * Used for retroactive autoblocks
5593 $wgPutIPinRC = true;
5596 * Integer defining default number of entries to show on
5597 * special pages which are query-pages such as Special:Whatlinkshere.
5599 $wgQueryPageDefaultLimit = 50;
5602 * Limit password attempts to X attempts per Y seconds per IP per account.
5604 * Value is an array of arrays. Each sub-array must have a key for count
5605 * (ie count of how many attempts before throttle) and a key for seconds.
5606 * If the key 'allIPs' (case sensitive) is present, then the limit is
5607 * just per account instead of per IP per account.
5609 * @since 1.27 allIps support and multiple limits added in 1.27. Prior
5610 * to 1.27 this only supported having a single throttle.
5611 * @warning Requires $wgMainCacheType to be enabled
5613 $wgPasswordAttemptThrottle = [
5615 [ 'count' => 5, 'seconds' => 300 ],
5616 // Long term limit. We need to balance the risk
5617 // of somebody using this as a DoS attack to lock someone
5618 // out of their account, and someone doing a brute force attack.
5619 [ 'count' => 150, 'seconds' => 60*60*48 ],
5623 * @var Array Map of (grant => right => boolean)
5624 * Users authorize consumers (like Apps) to act on their behalf but only with
5625 * a subset of the user's normal account rights (signed off on by the user).
5626 * The possible rights to grant to a consumer are bundled into groups called
5627 * "grants". Each grant defines some rights it lets consumers inherit from the
5628 * account they may act on behalf of. Note that a user granting a right does
5629 * nothing if that user does not actually have that right to begin with.
5632 $wgGrantPermissions = [];
5634 // @TODO: clean up grants
5635 // @TODO: auto-include read/editsemiprotected rights?
5637 $wgGrantPermissions['basic']['autoconfirmed'] = true;
5638 $wgGrantPermissions['basic']['autopatrol'] = true;
5639 $wgGrantPermissions['basic']['editsemiprotected'] = true;
5640 $wgGrantPermissions['basic']['ipblock-exempt'] = true;
5641 $wgGrantPermissions['basic']['nominornewtalk'] = true;
5642 $wgGrantPermissions['basic']['patrolmarks'] = true;
5643 $wgGrantPermissions['basic']['purge'] = true;
5644 $wgGrantPermissions['basic']['read'] = true;
5645 $wgGrantPermissions['basic']['skipcaptcha'] = true;
5646 $wgGrantPermissions['basic']['writeapi'] = true;
5648 $wgGrantPermissions['highvolume']['bot'] = true;
5649 $wgGrantPermissions['highvolume']['apihighlimits'] = true;
5650 $wgGrantPermissions['highvolume']['noratelimit'] = true;
5651 $wgGrantPermissions['highvolume']['markbotedits'] = true;
5653 $wgGrantPermissions['editpage']['edit'] = true;
5654 $wgGrantPermissions['editpage']['minoredit'] = true;
5655 $wgGrantPermissions['editpage']['applychangetags'] = true;
5656 $wgGrantPermissions['editpage']['changetags'] = true;
5658 $wgGrantPermissions['editprotected'] = $wgGrantPermissions['editpage'];
5659 $wgGrantPermissions['editprotected']['editprotected'] = true;
5661 $wgGrantPermissions['editmycssjs'] = $wgGrantPermissions['editpage'];
5662 $wgGrantPermissions['editmycssjs']['editmyusercss'] = true;
5663 $wgGrantPermissions['editmycssjs']['editmyuserjs'] = true;
5665 $wgGrantPermissions['editmyoptions']['editmyoptions'] = true;
5667 $wgGrantPermissions['editinterface'] = $wgGrantPermissions['editpage'];
5668 $wgGrantPermissions['editinterface']['editinterface'] = true;
5669 $wgGrantPermissions['editinterface']['editusercss'] = true;
5670 $wgGrantPermissions['editinterface']['edituserjs'] = true;
5672 $wgGrantPermissions['createeditmovepage'] = $wgGrantPermissions['editpage'];
5673 $wgGrantPermissions['createeditmovepage']['createpage'] = true;
5674 $wgGrantPermissions['createeditmovepage']['createtalk'] = true;
5675 $wgGrantPermissions['createeditmovepage']['move'] = true;
5676 $wgGrantPermissions['createeditmovepage']['move-rootuserpages'] = true;
5677 $wgGrantPermissions['createeditmovepage']['move-subpages'] = true;
5678 $wgGrantPermissions['createeditmovepage']['move-categorypages'] = true;
5680 $wgGrantPermissions['uploadfile']['upload'] = true;
5681 $wgGrantPermissions['uploadfile']['reupload-own'] = true;
5683 $wgGrantPermissions['uploadeditmovefile'] = $wgGrantPermissions['uploadfile'];
5684 $wgGrantPermissions['uploadeditmovefile']['reupload'] = true;
5685 $wgGrantPermissions['uploadeditmovefile']['reupload-shared'] = true;
5686 $wgGrantPermissions['uploadeditmovefile']['upload_by_url'] = true;
5687 $wgGrantPermissions['uploadeditmovefile']['movefile'] = true;
5688 $wgGrantPermissions['uploadeditmovefile']['suppressredirect'] = true;
5690 $wgGrantPermissions['patrol']['patrol'] = true;
5692 $wgGrantPermissions['rollback']['rollback'] = true;
5694 $wgGrantPermissions['blockusers']['block'] = true;
5695 $wgGrantPermissions['blockusers']['blockemail'] = true;
5697 $wgGrantPermissions['viewdeleted']['browsearchive'] = true;
5698 $wgGrantPermissions['viewdeleted']['deletedhistory'] = true;
5699 $wgGrantPermissions['viewdeleted']['deletedtext'] = true;
5701 $wgGrantPermissions['delete'] = $wgGrantPermissions['editpage'] +
5702 $wgGrantPermissions['viewdeleted'];
5703 $wgGrantPermissions['delete']['delete'] = true;
5704 $wgGrantPermissions['delete']['bigdelete'] = true;
5705 $wgGrantPermissions['delete']['deletelogentry'] = true;
5706 $wgGrantPermissions['delete']['deleterevision'] = true;
5707 $wgGrantPermissions['delete']['undelete'] = true;
5709 $wgGrantPermissions['protect'] = $wgGrantPermissions['editprotected'];
5710 $wgGrantPermissions['protect']['protect'] = true;
5712 $wgGrantPermissions['viewmywatchlist']['viewmywatchlist'] = true;
5714 $wgGrantPermissions['editmywatchlist']['editmywatchlist'] = true;
5716 $wgGrantPermissions['sendemail']['sendemail'] = true;
5718 $wgGrantPermissions['createaccount']['createaccount'] = true;
5721 * @var Array Map of grants to their UI grouping
5724 $wgGrantPermissionGroups = [
5725 // Hidden grants are implicitly present
5726 'basic' => 'hidden',
5728 'editpage' => 'page-interaction',
5729 'createeditmovepage' => 'page-interaction',
5730 'editprotected' => 'page-interaction',
5731 'patrol' => 'page-interaction',
5733 'uploadfile' => 'file-interaction',
5734 'uploadeditmovefile' => 'file-interaction',
5736 'sendemail' => 'email',
5738 'viewmywatchlist' => 'watchlist-interaction',
5739 'editviewmywatchlist' => 'watchlist-interaction',
5741 'editmycssjs' => 'customization',
5742 'editmyoptions' => 'customization',
5744 'editinterface' => 'administration',
5745 'rollback' => 'administration',
5746 'blockusers' => 'administration',
5747 'delete' => 'administration',
5748 'viewdeleted' => 'administration',
5749 'protect' => 'administration',
5750 'createaccount' => 'administration',
5752 'highvolume' => 'high-volume',
5756 * @var bool Whether to enable bot passwords
5759 $wgEnableBotPasswords = true;
5762 * Cluster for the bot_passwords table
5763 * @var string|bool If false, the normal cluster will be used
5766 $wgBotPasswordsCluster = false;
5769 * Database name for the bot_passwords table
5771 * To use a database with a table prefix, set this variable to
5772 * "{$database}-{$prefix}".
5773 * @var string|bool If false, the normal database will be used
5776 $wgBotPasswordsDatabase = false;
5778 /** @} */ # end of user rights settings
5780 /************************************************************************//**
5781 * @name Proxy scanner settings
5786 * This should always be customised in LocalSettings.php
5788 $wgSecretKey = false;
5791 * Big list of banned IP addresses.
5793 * This can have the following formats:
5794 * - An array of addresses, either in the values
5795 * or the keys (for backward compatibility)
5796 * - A string, in that case this is the path to a file
5797 * containing the list of IP addresses, one per line
5801 /** @} */ # end of proxy scanner settings
5803 /************************************************************************//**
5804 * @name Cookie settings
5809 * Default cookie lifetime, in seconds. Setting to 0 makes all cookies session-only.
5811 $wgCookieExpiration = 180 * 86400;
5814 * Default login cookie lifetime, in seconds. Setting
5815 * $wgExtendLoginCookieExpiration to null will use $wgCookieExpiration to
5816 * calculate the cookie lifetime. As with $wgCookieExpiration, 0 will make
5817 * login cookies session-only.
5819 $wgExtendedLoginCookieExpiration = null;
5822 * Set to set an explicit domain on the login cookies eg, "justthis.domain.org"
5823 * or ".any.subdomain.net"
5825 $wgCookieDomain = '';
5828 * Set this variable if you want to restrict cookies to a certain path within
5829 * the domain specified by $wgCookieDomain.
5831 $wgCookiePath = '/';
5834 * Whether the "secure" flag should be set on the cookie. This can be:
5835 * - true: Set secure flag
5836 * - false: Don't set secure flag
5837 * - "detect": Set the secure flag if $wgServer is set to an HTTPS URL
5839 $wgCookieSecure = 'detect';
5842 * By default, MediaWiki checks if the client supports cookies during the
5843 * login process, so that it can display an informative error message if
5844 * cookies are disabled. Set this to true if you want to disable this cookie
5847 $wgDisableCookieCheck = false;
5850 * Cookies generated by MediaWiki have names starting with this prefix. Set it
5851 * to a string to use a custom prefix. Setting it to false causes the database
5852 * name to be used as a prefix.
5854 $wgCookiePrefix = false;
5857 * Set authentication cookies to HttpOnly to prevent access by JavaScript,
5858 * in browsers that support this feature. This can mitigates some classes of
5861 $wgCookieHttpOnly = true;
5864 * A list of cookies that vary the cache (for use by extensions)
5866 $wgCacheVaryCookies = [];
5869 * Override to customise the session name
5871 $wgSessionName = false;
5873 /** @} */ # end of cookie settings }
5875 /************************************************************************//**
5876 * @name LaTeX (mathematical formulas)
5881 * To use inline TeX, you need to compile 'texvc' (in the 'math' subdirectory of
5882 * the MediaWiki package and have latex, dvips, gs (ghostscript), andconvert
5883 * (ImageMagick) installed and available in the PATH.
5884 * Please see math/README for more information.
5888 /** @} */ # end LaTeX }
5890 /************************************************************************//**
5891 * @name Profiling, testing and debugging
5893 * To enable profiling, edit StartProfiler.php
5899 * Filename for debug logging. See https://www.mediawiki.org/wiki/How_to_debug
5900 * The debug log file should be not be publicly accessible if it is used, as it
5901 * may contain private data.
5903 $wgDebugLogFile = '';
5906 * Prefix for debug log lines
5908 $wgDebugLogPrefix = '';
5911 * If true, instead of redirecting, show a page with a link to the redirect
5912 * destination. This allows for the inspection of PHP error messages, and easy
5913 * resubmission of form data. For developer use only.
5915 $wgDebugRedirects = false;
5918 * If true, log debugging data from action=raw and load.php.
5919 * This is normally false to avoid overlapping debug entries due to gen=css
5920 * and gen=js requests.
5922 $wgDebugRawPage = false;
5925 * Send debug data to an HTML comment in the output.
5927 * This may occasionally be useful when supporting a non-technical end-user.
5928 * It's more secure than exposing the debug log file to the web, since the
5929 * output only contains private data for the current user. But it's not ideal
5930 * for development use since data is lost on fatal errors and redirects.
5932 $wgDebugComments = false;
5935 * Write SQL queries to the debug log.
5937 * This setting is only used $wgLBFactoryConf['class'] is set to
5938 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
5939 * the DBO_DEBUG flag must be set in the 'flags' option of the database
5940 * connection to achieve the same functionality.
5942 $wgDebugDumpSql = false;
5945 * Performance expectations for DB usage
5949 $wgTrxProfilerLimits = [
5950 // HTTP GET/HEAD requests.
5951 // Master queries should not happen on GET requests
5955 'readQueryTime' => 5
5957 // HTTP POST requests.
5958 // Master reads and writes will happen for a subset of these.
5960 'readQueryTime' => 5,
5961 'writeQueryTime' => 1,
5962 'maxAffected' => 500
5964 'POST-nonwrite' => [
5967 'readQueryTime' => 5
5969 // Deferred updates that run after HTTP response is sent
5971 'readQueryTime' => 5,
5972 'writeQueryTime' => 1,
5973 'maxAffected' => 500
5975 // Background job runner
5977 'readQueryTime' => 30,
5978 'writeQueryTime' => 5,
5979 'maxAffected' => 1000
5981 // Command-line scripts
5983 'writeQueryTime' => 5,
5984 'maxAffected' => 1000
5989 * Map of string log group names to log destinations.
5991 * If set, wfDebugLog() output for that group will go to that file instead
5992 * of the regular $wgDebugLogFile. Useful for enabling selective logging
5995 * Log destinations may be one of the following:
5996 * - false to completely remove from the output, including from $wgDebugLogFile.
5997 * - string values specifying a filename or URI.
5998 * - associative array with keys:
5999 * - 'destination' desired filename or URI.
6000 * - 'sample' an integer value, specifying a sampling factor (optional)
6001 * - 'level' A \Psr\Log\LogLevel constant, indicating the minimum level
6002 * to log (optional, since 1.25)
6006 * $wgDebugLogGroups['redis'] = '/var/log/mediawiki/redis.log';
6009 * @par Advanced example:
6011 * $wgDebugLogGroups['memcached'] = [
6012 * 'destination' => '/var/log/mediawiki/memcached.log',
6013 * 'sample' => 1000, // log 1 message out of every 1,000.
6014 * 'level' => \Psr\Log\LogLevel::WARNING
6018 $wgDebugLogGroups = [];
6021 * Default service provider for creating Psr\Log\LoggerInterface instances.
6023 * The value should be an array suitable for use with
6024 * ObjectFactory::getObjectFromSpec(). The created object is expected to
6025 * implement the MediaWiki\Logger\Spi interface. See ObjectFactory for additional
6028 * Alternately the MediaWiki\Logger\LoggerFactory::registerProvider method can
6029 * be called to inject an MediaWiki\Logger\Spi instance into the LoggerFactory
6030 * and bypass the use of this configuration variable entirely.
6032 * @par To completely disable logging:
6034 * $wgMWLoggerDefaultSpi = [ 'class' => '\\MediaWiki\\Logger\\NullSpi' ];
6038 * @var array $wgMWLoggerDefaultSpi
6041 $wgMWLoggerDefaultSpi = [
6042 'class' => '\\MediaWiki\\Logger\\LegacySpi',
6046 * Display debug data at the bottom of the main content area.
6048 * Useful for developers and technical users trying to working on a closed wiki.
6050 $wgShowDebug = false;
6053 * Prefix debug messages with relative timestamp. Very-poor man's profiler.
6054 * Since 1.19 also includes memory usage.
6056 $wgDebugTimestamps = false;
6059 * Print HTTP headers for every request in the debug information.
6061 $wgDebugPrintHttpHeaders = true;
6064 * Show the contents of $wgHooks in Special:Version
6066 $wgSpecialVersionShowHooks = false;
6069 * Whether to show "we're sorry, but there has been a database error" pages.
6070 * Displaying errors aids in debugging, but may display information useful
6073 $wgShowSQLErrors = false;
6076 * If set to true, uncaught exceptions will print a complete stack trace
6077 * to output. This should only be used for debugging, as it may reveal
6078 * private information in function parameters due to PHP's backtrace
6081 $wgShowExceptionDetails = false;
6084 * If true, show a backtrace for database errors
6086 * @note This setting only applies when connection errors and query errors are
6087 * reported in the normal manner. $wgShowExceptionDetails applies in other cases,
6088 * including those in which an uncaught exception is thrown from within the
6089 * exception handler.
6091 $wgShowDBErrorBacktrace = false;
6094 * If true, send the exception backtrace to the error log
6096 $wgLogExceptionBacktrace = true;
6099 * Expose backend server host names through the API and various HTML comments
6101 $wgShowHostnames = false;
6104 * Override server hostname detection with a hardcoded value.
6105 * Should be a string, default false.
6108 $wgOverrideHostname = false;
6111 * If set to true MediaWiki will throw notices for some possible error
6112 * conditions and for deprecated functions.
6114 $wgDevelopmentWarnings = false;
6117 * Release limitation to wfDeprecated warnings, if set to a release number
6118 * development warnings will not be generated for deprecations added in releases
6121 $wgDeprecationReleaseLimit = false;
6124 * Only record profiling info for pages that took longer than this
6125 * @deprecated since 1.25: set $wgProfiler['threshold'] instead.
6127 $wgProfileLimit = 0.0;
6130 * Don't put non-profiling info into log file
6132 * @deprecated since 1.23, set the log file in
6133 * $wgDebugLogGroups['profileoutput'] instead.
6135 $wgProfileOnly = false;
6138 * Destination of statsd metrics.
6140 * A host or host:port of a statsd server. Port defaults to 8125.
6142 * If not set, statsd metrics will not be collected.
6144 * @see wfLogProfilingData
6147 $wgStatsdServer = false;
6150 * Prefix for metric names sent to $wgStatsdServer.
6152 * @see MediaWikiServices::getStatsdDataFactory
6153 * @see BufferingStatsdDataFactory
6156 $wgStatsdMetricPrefix = 'MediaWiki';
6159 * InfoAction retrieves a list of transclusion links (both to and from).
6160 * This number puts a limit on that query in the case of highly transcluded
6163 $wgPageInfoTransclusionLimit = 50;
6166 * Set this to an integer to only do synchronous site_stats updates
6167 * one every *this many* updates. The other requests go into pending
6168 * delta values in $wgMemc. Make sure that $wgMemc is a global cache.
6169 * If set to -1, updates *only* go to $wgMemc (useful for daemons).
6171 $wgSiteStatsAsyncFactor = false;
6174 * Parser test suite files to be run by parserTests.php when no specific
6175 * filename is passed to it.
6177 * Extensions may add their own tests to this array, or site-local tests
6178 * may be added via LocalSettings.php
6182 $wgParserTestFiles = [
6183 "$IP/tests/parser/parserTests.txt",
6184 "$IP/tests/parser/extraParserTests.txt"
6188 * Allow running of javascript test suites via [[Special:JavaScriptTest]] (such as QUnit).
6190 $wgEnableJavaScriptTest = false;
6193 * Overwrite the caching key prefix with custom value.
6196 $wgCachePrefix = false;
6199 * Display the new debugging toolbar. This also enables profiling on database
6200 * queries and other useful output.
6201 * Will be ignored if $wgUseFileCache or $wgUseSquid is enabled.
6205 $wgDebugToolbar = false;
6207 /** @} */ # end of profiling, testing and debugging }
6209 /************************************************************************//**
6215 * Set this to true to disable the full text search feature.
6217 $wgDisableTextSearch = false;
6220 * Set to true to have nicer highlighted text in search results,
6221 * by default off due to execution overhead
6223 $wgAdvancedSearchHighlighting = false;
6226 * Regexp to match word boundaries, defaults for non-CJK languages
6227 * should be empty for CJK since the words are not separate
6229 $wgSearchHighlightBoundaries = '[\p{Z}\p{P}\p{C}]';
6232 * Template for OpenSearch suggestions, defaults to API action=opensearch
6234 * Sites with heavy load would typically have these point to a custom
6235 * PHP wrapper to avoid firing up mediawiki for every keystroke
6237 * Placeholders: {searchTerms}
6239 * @deprecated since 1.25 Use $wgOpenSearchTemplates['application/x-suggestions+json'] instead
6241 $wgOpenSearchTemplate = false;
6244 * Templates for OpenSearch suggestions, defaults to API action=opensearch
6246 * Sites with heavy load would typically have these point to a custom
6247 * PHP wrapper to avoid firing up mediawiki for every keystroke
6249 * Placeholders: {searchTerms}
6251 $wgOpenSearchTemplates = [
6252 'application/x-suggestions+json' => false,
6253 'application/x-suggestions+xml' => false,
6257 * Enable OpenSearch suggestions requested by MediaWiki. Set this to
6258 * false if you've disabled scripts that use api?action=opensearch and
6259 * want reduce load caused by cached scripts still pulling suggestions.
6260 * It will let the API fallback by responding with an empty array.
6262 $wgEnableOpenSearchSuggest = true;
6265 * Integer defining default number of entries to show on
6268 $wgOpenSearchDefaultLimit = 10;
6271 * Minimum length of extract in <Description>. Actual extracts will last until the end of sentence.
6273 $wgOpenSearchDescriptionLength = 100;
6276 * Expiry time for search suggestion responses
6278 $wgSearchSuggestCacheExpiry = 1200;
6281 * If you've disabled search semi-permanently, this also disables updates to the
6282 * table. If you ever re-enable, be sure to rebuild the search table.
6284 $wgDisableSearchUpdate = false;
6287 * List of namespaces which are searched by default.
6291 * $wgNamespacesToBeSearchedDefault[NS_MAIN] = true;
6292 * $wgNamespacesToBeSearchedDefault[NS_PROJECT] = true;
6295 $wgNamespacesToBeSearchedDefault = [
6300 * Disable the internal MySQL-based search, to allow it to be
6301 * implemented by an extension instead.
6303 $wgDisableInternalSearch = false;
6306 * Set this to a URL to forward search requests to some external location.
6307 * If the URL includes '$1', this will be replaced with the URL-encoded
6311 * To forward to Google you'd have something like:
6313 * $wgSearchForwardUrl =
6314 * 'http://www.google.com/search?q=$1' .
6315 * '&domains=http://example.com' .
6316 * '&sitesearch=http://example.com' .
6317 * '&ie=utf-8&oe=utf-8';
6320 $wgSearchForwardUrl = null;
6323 * Search form behavior.
6324 * - true = use Go & Search buttons
6325 * - false = use Go button & Advanced search link
6327 $wgUseTwoButtonsSearchForm = true;
6330 * Array of namespaces to generate a Google sitemap for when the
6331 * maintenance/generateSitemap.php script is run, or false if one is to be
6332 * generated for all namespaces.
6334 $wgSitemapNamespaces = false;
6337 * Custom namespace priorities for sitemaps. Setting this will allow you to
6338 * set custom priorities to namespaces when sitemaps are generated using the
6339 * maintenance/generateSitemap.php script.
6341 * This should be a map of namespace IDs to priority
6344 * $wgSitemapNamespacesPriorities = [
6350 $wgSitemapNamespacesPriorities = false;
6353 * If true, searches for IP addresses will be redirected to that IP's
6354 * contributions page. E.g. searching for "1.2.3.4" will redirect to
6355 * [[Special:Contributions/1.2.3.4]]
6357 $wgEnableSearchContributorsByIP = true;
6359 /** @} */ # end of search settings
6361 /************************************************************************//**
6362 * @name Edit user interface
6367 * Path to the GNU diff3 utility. If the file doesn't exist, edit conflicts will
6368 * fall back to the old behavior (no merging).
6370 $wgDiff3 = '/usr/bin/diff3';
6373 * Path to the GNU diff utility.
6375 $wgDiff = '/usr/bin/diff';
6378 * Which namespaces have special treatment where they should be preview-on-open
6379 * Internally only Category: pages apply, but using this extensions (e.g. Semantic MediaWiki)
6380 * can specify namespaces of pages they have special treatment for
6382 $wgPreviewOnOpenNamespaces = [
6387 * Enable the UniversalEditButton for browsers that support it
6388 * (currently only Firefox with an extension)
6389 * See http://universaleditbutton.org for more background information
6391 $wgUniversalEditButton = true;
6394 * If user doesn't specify any edit summary when making a an edit, MediaWiki
6395 * will try to automatically create one. This feature can be disabled by set-
6396 * ting this variable false.
6398 $wgUseAutomaticEditSummaries = true;
6400 /** @} */ # end edit UI }
6402 /************************************************************************//**
6404 * See also $wgSiteNotice
6409 * @cond file_level_code
6410 * Set $wgCommandLineMode if it's not set already, to avoid notices
6412 if ( !isset( $wgCommandLineMode ) ) {
6413 $wgCommandLineMode = false;
6418 * For colorized maintenance script output, is your terminal background dark ?
6420 $wgCommandLineDarkBg = false;
6423 * Set this to a string to put the wiki into read-only mode. The text will be
6424 * used as an explanation to users.
6426 * This prevents most write operations via the web interface. Cache updates may
6427 * still be possible. To prevent database writes completely, use the read_only
6433 * If this lock file exists (size > 0), the wiki will be forced into read-only mode.
6434 * Its contents will be shown to users as part of the read-only warning
6437 * Will default to "{$wgUploadDirectory}/lock_yBgMBwiR" in Setup.php
6439 $wgReadOnlyFile = false;
6442 * When you run the web-based upgrade utility, it will tell you what to set
6443 * this to in order to authorize the upgrade process. It will subsequently be
6444 * used as a password, to authorize further upgrades.
6446 * For security, do not set this to a guessable string. Use the value supplied
6447 * by the install/upgrade process. To cause the upgrader to generate a new key,
6448 * delete the old key from LocalSettings.php.
6450 $wgUpgradeKey = false;
6453 * Fully specified path to git binary
6455 $wgGitBin = '/usr/bin/git';
6458 * Map GIT repository URLs to viewer URLs to provide links in Special:Version
6460 * Key is a pattern passed to preg_match() and preg_replace(),
6461 * without the delimiters (which are #) and must match the whole URL.
6462 * The value is the replacement for the key (it can contain $1, etc.)
6463 * %h will be replaced by the short SHA-1 (7 first chars) and %H by the
6464 * full SHA-1 of the HEAD revision.
6465 * %r will be replaced with a URL-encoded version of $1.
6466 * %R will be replaced with $1 and no URL-encoding
6470 $wgGitRepositoryViewers = [
6471 'https://(?:[a-z0-9_]+@)?gerrit.wikimedia.org/r/(?:p/)?(.*)' =>
6472 'https://phabricator.wikimedia.org/r/revision/%R;%H',
6473 'ssh://(?:[a-z0-9_]+@)?gerrit.wikimedia.org:29418/(.*)' =>
6474 'https://phabricator.wikimedia.org/r/revision/%R;%H',
6477 /** @} */ # End of maintenance }
6479 /************************************************************************//**
6480 * @name Recent changes, new pages, watchlist and history
6485 * Recentchanges items are periodically purged; entries older than this many
6487 * Default: 90 days = about three months
6489 $wgRCMaxAge = 90 * 24 * 3600;
6492 * Page watchers inactive for more than this many seconds are considered inactive.
6493 * Used mainly by action=info. Default: 180 days = about six months.
6496 $wgWatchersMaxAge = 180 * 24 * 3600;
6499 * If active watchers (per above) are this number or less, do not disclose it.
6500 * Left to 1, prevents unprivileged users from knowing for sure that there are 0.
6501 * Set to -1 if you want to always complement watchers count with this info.
6504 $wgUnwatchedPageSecret = 1;
6507 * Filter $wgRCLinkDays by $wgRCMaxAge to avoid showing links for numbers
6508 * higher than what will be stored. Note that this is disabled by default
6509 * because we sometimes do have RC data which is beyond the limit for some
6510 * reason, and some users may use the high numbers to display that data which
6513 $wgRCFilterByAge = false;
6516 * List of Limits options to list in the Special:Recentchanges and
6517 * Special:Recentchangeslinked pages.
6519 $wgRCLinkLimits = [ 50, 100, 250, 500 ];
6522 * List of Days options to list in the Special:Recentchanges and
6523 * Special:Recentchangeslinked pages.
6525 $wgRCLinkDays = [ 1, 3, 7, 14, 30 ];
6528 * Destinations to which notifications about recent changes
6531 * As of MediaWiki 1.22, there are 2 supported 'engine' parameter option in core:
6532 * * 'UDPRCFeedEngine', which is used to send recent changes over UDP to the
6534 * * 'RedisPubSubFeedEngine', which is used to send recent changes to Redis.
6536 * The common options are:
6537 * * 'uri' -- the address to which the notices are to be sent.
6538 * * 'formatter' -- the class name (implementing RCFeedFormatter) which will
6539 * produce the text to send. This can also be an object of the class.
6540 * * 'omit_bots' -- whether the bot edits should be in the feed
6541 * * 'omit_anon' -- whether anonymous edits should be in the feed
6542 * * 'omit_user' -- whether edits by registered users should be in the feed
6543 * * 'omit_minor' -- whether minor edits should be in the feed
6544 * * 'omit_patrolled' -- whether patrolled edits should be in the feed
6546 * The IRC-specific options are:
6547 * * 'add_interwiki_prefix' -- whether the titles should be prefixed with
6548 * the first entry in the $wgLocalInterwikis array (or the value of
6549 * $wgLocalInterwiki, if set)
6551 * The JSON-specific options are:
6552 * * 'channel' -- if set, the 'channel' parameter is also set in JSON values.
6554 * @example $wgRCFeeds['example'] = [
6555 * 'formatter' => 'JSONRCFeedFormatter',
6556 * 'uri' => "udp://localhost:1336",
6557 * 'add_interwiki_prefix' => false,
6558 * 'omit_bots' => true,
6560 * @example $wgRCFeeds['exampleirc'] = [
6561 * 'formatter' => 'IRCColourfulRCFeedFormatter',
6562 * 'uri' => "udp://localhost:1338",
6563 * 'add_interwiki_prefix' => false,
6564 * 'omit_bots' => true,
6571 * Used by RecentChange::getEngine to find the correct engine to use for a given URI scheme.
6572 * Keys are scheme names, values are names of engine classes.
6575 'redis' => 'RedisPubSubFeedEngine',
6576 'udp' => 'UDPRCFeedEngine',
6580 * Treat category membership changes as a RecentChange.
6581 * Changes are mentioned in RC for page actions as follows:
6582 * - creation: pages created with categories are mentioned
6583 * - edit: category additions/removals to existing pages are mentioned
6584 * - move: nothing is mentioned (unless templates used depend on the title)
6585 * - deletion: nothing is mentioned
6586 * - undeletion: nothing is mentioned
6590 $wgRCWatchCategoryMembership = false;
6593 * Use RC Patrolling to check for vandalism (from recent changes and watchlists)
6594 * New pages and new files are included.
6596 $wgUseRCPatrol = true;
6599 * Use new page patrolling to check new pages on Special:Newpages
6601 $wgUseNPPatrol = true;
6604 * Use file patrolling to check new files on Special:Newfiles
6608 $wgUseFilePatrol = true;
6611 * Log autopatrol actions to the log table
6613 $wgLogAutopatrol = true;
6616 * Provide syndication feeds (RSS, Atom) for, e.g., Recentchanges, Newpages
6621 * Set maximum number of results to return in syndication feeds (RSS, Atom) for
6622 * eg Recentchanges, Newpages.
6627 * _Minimum_ timeout for cached Recentchanges feed, in seconds.
6628 * A cached version will continue to be served out even if changes
6629 * are made, until this many seconds runs out since the last render.
6631 * If set to 0, feed caching is disabled. Use this for debugging only;
6632 * feed generation can be pretty slow with diffs.
6634 $wgFeedCacheTimeout = 60;
6637 * When generating Recentchanges RSS/Atom feed, diffs will not be generated for
6638 * pages larger than this size.
6640 $wgFeedDiffCutoff = 32768;
6643 * Override the site's default RSS/ATOM feed for recentchanges that appears on
6644 * every page. Some sites might have a different feed they'd like to promote
6645 * instead of the RC feed (maybe like a "Recent New Articles" or "Breaking news" one).
6646 * Should be a format as key (either 'rss' or 'atom') and an URL to the feed
6649 * Configure the 'atom' feed to http://example.com/somefeed.xml
6651 * $wgSiteFeed['atom'] = "http://example.com/somefeed.xml";
6654 $wgOverrideSiteFeed = [];
6657 * Available feeds objects.
6658 * Should probably only be defined when a page is syndicated ie when
6659 * $wgOut->isSyndicated() is true.
6663 'atom' => 'AtomFeed',
6667 * Which feed types should we provide by default? This can include 'rss',
6668 * 'atom', neither, or both.
6670 $wgAdvertisedFeedTypes = [ 'atom' ];
6673 * Show watching users in recent changes, watchlist and page history views
6675 $wgRCShowWatchingUsers = false; # UPO
6678 * Show the amount of changed characters in recent changes
6680 $wgRCShowChangedSize = true;
6683 * If the difference between the character counts of the text
6684 * before and after the edit is below that value, the value will be
6685 * highlighted on the RC page.
6687 $wgRCChangedSizeThreshold = 500;
6690 * Show "Updated (since my last visit)" marker in RC view, watchlist and history
6691 * view for watched pages with new changes
6693 $wgShowUpdatedMarker = true;
6696 * Disable links to talk pages of anonymous users (IPs) in listings on special
6697 * pages like page history, Special:Recentchanges, etc.
6699 $wgDisableAnonTalk = false;
6702 * Enable filtering of categories in Recentchanges
6704 $wgAllowCategorizedRecentChanges = false;
6707 * Allow filtering by change tag in recentchanges, history, etc
6708 * Has no effect if no tags are defined in valid_tag.
6710 $wgUseTagFilter = true;
6713 * If set to an integer, pages that are watched by this many users or more
6714 * will not require the unwatchedpages permission to view the number of
6719 $wgUnwatchedPageThreshold = false;
6722 * Flags (letter symbols) shown in recent changes and watchlist to indicate
6723 * certain types of edits.
6725 * To register a new one:
6727 * $wgRecentChangesFlags['flag'] => [
6728 * // message for the letter displayed next to rows on changes lists
6729 * 'letter' => 'letter-msg',
6730 * // message for the tooltip of the letter
6731 * 'title' => 'tooltip-msg',
6732 * // optional (defaults to 'tooltip-msg'), message to use in the legend box
6733 * 'legend' => 'legend-msg',
6734 * // optional (defaults to 'flag'), CSS class to put on changes lists rows
6735 * 'class' => 'css-class',
6736 * // optional (defaults to 'any'), how top-level flag is determined. 'any'
6737 * // will set the top-level flag if any line contains the flag, 'all' will
6738 * // only be set if all lines contain the flag.
6739 * 'grouping' => 'any',
6745 $wgRecentChangesFlags = [
6747 'letter' => 'newpageletter',
6748 'title' => 'recentchanges-label-newpage',
6749 'legend' => 'recentchanges-legend-newpage',
6750 'grouping' => 'any',
6753 'letter' => 'minoreditletter',
6754 'title' => 'recentchanges-label-minor',
6755 'legend' => 'recentchanges-legend-minor',
6756 'class' => 'minoredit',
6757 'grouping' => 'all',
6760 'letter' => 'boteditletter',
6761 'title' => 'recentchanges-label-bot',
6762 'legend' => 'recentchanges-legend-bot',
6763 'class' => 'botedit',
6764 'grouping' => 'all',
6767 'letter' => 'unpatrolledletter',
6768 'title' => 'recentchanges-label-unpatrolled',
6769 'legend' => 'recentchanges-legend-unpatrolled',
6770 'grouping' => 'any',
6774 /** @} */ # end RC/watchlist }
6776 /************************************************************************//**
6777 * @name Copyright and credits settings
6782 * Override for copyright metadata.
6784 * This is the name of the page containing information about the wiki's copyright status,
6785 * which will be added as a link in the footer if it is specified. It overrides
6786 * $wgRightsUrl if both are specified.
6788 $wgRightsPage = null;
6791 * Set this to specify an external URL containing details about the content license used on your
6793 * If $wgRightsPage is set then this setting is ignored.
6795 $wgRightsUrl = null;
6798 * If either $wgRightsUrl or $wgRightsPage is specified then this variable gives the text for the
6800 * If using $wgRightsUrl then this value must be specified. If using $wgRightsPage then the name
6801 * of the page will also be used as the link if this variable is not set.
6803 $wgRightsText = null;
6806 * Override for copyright metadata.
6808 $wgRightsIcon = null;
6811 * Set this to true if you want detailed copyright information forms on Upload.
6813 $wgUseCopyrightUpload = false;
6816 * Set this to the number of authors that you want to be credited below an
6817 * article text. Set it to zero to hide the attribution block, and a negative
6818 * number (like -1) to show all authors. Note that this will require 2-3 extra
6819 * database hits, which can have a not insignificant impact on performance for
6825 * If there are more than $wgMaxCredits authors, show $wgMaxCredits of them.
6826 * Otherwise, link to a separate credits page.
6828 $wgShowCreditsIfMax = true;
6830 /** @} */ # end of copyright and credits settings }
6832 /************************************************************************//**
6833 * @name Import / Export
6838 * List of interwiki prefixes for wikis we'll accept as sources for
6839 * Special:Import and API action=import. Since complete page history can be
6840 * imported, these should be 'trusted'.
6842 * This can either be a regular array, or an associative map specifying
6843 * subprojects on the interwiki map of the target wiki, or a mix of the two,
6846 * $wgImportSources = [
6847 * 'wikipedia' => [ 'cs', 'en', 'fr', 'zh' ],
6849 * 'wikia' => [ 'animanga', 'brickipedia', 'desserts' ],
6853 * If you have a very complex import sources setup, you can lazy-load it using
6854 * the ImportSources hook.
6856 * If a user has the 'import' permission but not the 'importupload' permission,
6857 * they will only be able to run imports through this transwiki interface.
6859 $wgImportSources = [];
6862 * Optional default target namespace for interwiki imports.
6863 * Can use this to create an incoming "transwiki"-style queue.
6864 * Set to numeric key, not the name.
6866 * Users may override this in the Special:Import dialog.
6868 $wgImportTargetNamespace = null;
6871 * If set to false, disables the full-history option on Special:Export.
6872 * This is currently poorly optimized for long edit histories, so is
6873 * disabled on Wikimedia's sites.
6875 $wgExportAllowHistory = true;
6878 * If set nonzero, Special:Export requests for history of pages with
6879 * more revisions than this will be rejected. On some big sites things
6880 * could get bogged down by very very long pages.
6882 $wgExportMaxHistory = 0;
6885 * Return distinct author list (when not returning full history)
6887 $wgExportAllowListContributors = false;
6890 * If non-zero, Special:Export accepts a "pagelink-depth" parameter
6891 * up to this specified level, which will cause it to include all
6892 * pages linked to from the pages you specify. Since this number
6893 * can become *insanely large* and could easily break your wiki,
6894 * it's disabled by default for now.
6896 * @warning There's a HARD CODED limit of 5 levels of recursion to prevent a
6897 * crazy-big export from being done by someone setting the depth number too
6898 * high. In other words, last resort safety net.
6900 $wgExportMaxLinkDepth = 0;
6903 * Whether to allow the "export all pages in namespace" option
6905 $wgExportFromNamespaces = false;
6908 * Whether to allow exporting the entire wiki into a single file
6910 $wgExportAllowAll = false;
6913 * Maximum number of pages returned by the GetPagesFromCategory and
6914 * GetPagesFromNamespace functions.
6918 $wgExportPagelistLimit = 5000;
6920 /** @} */ # end of import/export }
6922 /*************************************************************************//**
6928 * A list of callback functions which are called once MediaWiki is fully
6931 $wgExtensionFunctions = [];
6934 * Extension messages files.
6936 * Associative array mapping extension name to the filename where messages can be
6937 * found. The file should contain variable assignments. Any of the variables
6938 * present in languages/messages/MessagesEn.php may be defined, but $messages
6939 * is the most common.
6941 * Variables defined in extensions will override conflicting variables defined
6944 * Since MediaWiki 1.23, use of this variable to define messages is discouraged; instead, store
6945 * messages in JSON format and use $wgMessagesDirs. For setting other variables than
6946 * $messages, $wgExtensionMessagesFiles should still be used. Use a DIFFERENT key because
6947 * any entry having a key that also exists in $wgMessagesDirs will be ignored.
6949 * Extensions using the JSON message format can preserve backward compatibility with
6950 * earlier versions of MediaWiki by using a compatibility shim, such as one generated
6951 * by the generateJsonI18n.php maintenance script, listing it under the SAME key
6952 * as for the $wgMessagesDirs entry.
6956 * $wgExtensionMessagesFiles['ConfirmEdit'] = __DIR__.'/ConfirmEdit.i18n.php';
6959 $wgExtensionMessagesFiles = [];
6962 * Extension messages directories.
6964 * Associative array mapping extension name to the path of the directory where message files can
6965 * be found. The message files are expected to be JSON files named for their language code, e.g.
6966 * en.json, de.json, etc. Extensions with messages in multiple places may specify an array of
6967 * message directories.
6969 * Message directories in core should be added to LocalisationCache::getMessagesDirs()
6971 * @par Simple example:
6973 * $wgMessagesDirs['Example'] = __DIR__ . '/i18n';
6976 * @par Complex example:
6978 * $wgMessagesDirs['Example'] = [
6979 * __DIR__ . '/lib/ve/i18n',
6980 * __DIR__ . '/lib/oojs-ui/i18n',
6981 * __DIR__ . '/i18n',
6986 $wgMessagesDirs = [];
6989 * Array of files with list(s) of extension entry points to be used in
6990 * maintenance/mergeMessageFileList.php
6993 $wgExtensionEntryPointListFiles = [];
6996 * Parser output hooks.
6997 * This is an associative array where the key is an extension-defined tag
6998 * (typically the extension name), and the value is a PHP callback.
6999 * These will be called as an OutputPageParserOutput hook, if the relevant
7000 * tag has been registered with the parser output object.
7002 * Registration is done with $pout->addOutputHook( $tag, $data ).
7004 * The callback has the form:
7006 * function outputHook( $outputPage, $parserOutput, $data ) { ... }
7009 $wgParserOutputHooks = [];
7012 * Whether to include the NewPP limit report as a HTML comment
7014 $wgEnableParserLimitReporting = true;
7017 * List of valid skin names
7019 * The key should be the name in all lower case, the value should be a properly
7020 * cased name for the skin. This value will be prefixed with "Skin" to create
7021 * the class name of the skin to load. Use Skin::getSkinNames() as an accessor
7022 * if you wish to have access to the full list.
7024 $wgValidSkinNames = [];
7027 * Special page list. This is an associative array mapping the (canonical) names of
7028 * special pages to either a class name to be instantiated, or a callback to use for
7029 * creating the special page object. In both cases, the result must be an instance of
7032 $wgSpecialPages = [];
7035 * Array mapping class names to filenames, for autoloading.
7037 $wgAutoloadClasses = [];
7040 * Switch controlling legacy case-insensitive classloading.
7041 * Do not disable if your wiki must support data created by PHP4, or by
7042 * MediaWiki 1.4 or earlier.
7044 $wgAutoloadAttemptLowercase = true;
7047 * An array of information about installed extensions keyed by their type.
7049 * All but 'name', 'path' and 'author' can be omitted.
7052 * $wgExtensionCredits[$type][] = [
7053 * 'path' => __FILE__,
7054 * 'name' => 'Example extension',
7055 * 'namemsg' => 'exampleextension-name',
7059 * 'version' => '1.9.0',
7060 * 'url' => 'http://example.org/example-extension/',
7061 * 'descriptionmsg' => 'exampleextension-desc',
7062 * 'license-name' => 'GPL-2.0+',
7066 * The extensions are listed on Special:Version. This page also looks for a file
7067 * named COPYING or LICENSE (optional .txt extension) and provides a link to
7068 * view said file. When the 'license-name' key is specified, this file is
7069 * interpreted as wikitext.
7071 * - $type: One of 'specialpage', 'parserhook', 'variable', 'media', 'antispam',
7072 * 'skin', 'api', or 'other', or any additional types as specified through the
7073 * ExtensionTypes hook as used in SpecialVersion::getExtensionTypes().
7075 * - name: Name of extension as an inline string instead of localizable message.
7076 * Do not omit this even if 'namemsg' is provided, as it is used to override
7077 * the path Special:Version uses to find extension's license info, and is
7078 * required for backwards-compatibility with MediaWiki 1.23 and older.
7080 * - namemsg (since MW 1.24): A message key for a message containing the
7081 * extension's name, if the name is localizable. (For example, skin names
7084 * - author: A string or an array of strings. Authors can be linked using
7085 * the regular wikitext link syntax. To have an internationalized version of
7086 * "and others" show, add an element "...". This element can also be linked,
7087 * for instance "[http://example ...]".
7089 * - descriptionmsg: A message key or an an array with message key and parameters:
7090 * `'descriptionmsg' => 'exampleextension-desc',`
7092 * - description: Description of extension as an inline string instead of
7093 * localizable message (omit in favour of 'descriptionmsg').
7095 * - license-name: Short name of the license (used as label for the link), such
7096 * as "GPL-2.0+" or "MIT" (https://spdx.org/licenses/ for a list of identifiers).
7098 $wgExtensionCredits = [];
7101 * Authentication plugin.
7102 * @var $wgAuth AuthPlugin
7103 * @deprecated since 1.27 use $wgAuthManagerConfig instead
7108 * Global list of hooks.
7110 * The key is one of the events made available by MediaWiki, you can find
7111 * a description for most of them in docs/hooks.txt. The array is used
7112 * internally by Hook:run().
7114 * The value can be one of:
7116 * - A function name:
7118 * $wgHooks['event_name'][] = $function;
7120 * - A function with some data:
7122 * $wgHooks['event_name'][] = [ $function, $data ];
7124 * - A an object method:
7126 * $wgHooks['event_name'][] = [ $object, 'method' ];
7130 * $wgHooks['event_name'][] = function ( $hookParam ) {
7131 * // Handler code goes here.
7135 * @warning You should always append to an event array or you will end up
7136 * deleting a previous registered hook.
7138 * @warning Hook handlers should be registered at file scope. Registering
7139 * handlers after file scope can lead to unexpected results due to caching.
7144 * List of service wiring files to be loaded by the default instance of MediaWikiServices.
7145 * Each file listed here is expected to return an associative array mapping service names
7146 * to instantiator functions. Extensions may add wiring files to define their own services.
7147 * However, this cannot be used to replace existing services - use the MediaWikiServices
7150 * @see MediaWikiServices
7151 * @see ServiceContainer::loadWiringFiles() for details on loading service instantiator functions.
7152 * @see docs/injection.txt for an overview of dependency injection in MediaWiki.
7154 $wgServiceWiringFiles = [
7155 __DIR__
. '/ServiceWiring.php'
7159 * Maps jobs to their handling classes; extensions
7160 * can add to this to provide custom jobs
7163 'refreshLinks' => 'RefreshLinksJob',
7164 'deleteLinks' => 'DeleteLinksJob',
7165 'htmlCacheUpdate' => 'HTMLCacheUpdateJob',
7166 'sendMail' => 'EmaillingJob',
7167 'enotifNotify' => 'EnotifNotifyJob',
7168 'fixDoubleRedirect' => 'DoubleRedirectJob',
7169 'AssembleUploadChunks' => 'AssembleUploadChunksJob',
7170 'PublishStashedFile' => 'PublishStashedFileJob',
7171 'ThumbnailRender' => 'ThumbnailRenderJob',
7172 'recentChangesUpdate' => 'RecentChangesUpdateJob',
7173 'refreshLinksPrioritized' => 'RefreshLinksJob',
7174 'refreshLinksDynamic' => 'RefreshLinksJob',
7175 'activityUpdateJob' => 'ActivityUpdateJob',
7176 'categoryMembershipChange' => 'CategoryMembershipChangeJob',
7177 'cdnPurge' => 'CdnPurgeJob',
7178 'enqueue' => 'EnqueueJob', // local queue for multi-DC setups
7183 * Jobs that must be explicitly requested, i.e. aren't run by job runners unless
7184 * special flags are set. The values here are keys of $wgJobClasses.
7187 * - Very long-running jobs.
7188 * - Jobs that you would never want to run as part of a page rendering request.
7189 * - Jobs that you want to run on specialized machines ( like transcoding, or a particular
7190 * machine on your cluster has 'outside' web access you could restrict uploadFromUrl )
7191 * These settings should be global to all wikis.
7193 $wgJobTypesExcludedFromDefaultQueue = [ 'AssembleUploadChunks', 'PublishStashedFile' ];
7196 * Map of job types to how many job "work items" should be run per second
7197 * on each job runner process. The meaning of "work items" varies per job,
7198 * but typically would be something like "pages to update". A single job
7199 * may have a variable number of work items, as is the case with batch jobs.
7200 * This is used by runJobs.php and not jobs run via $wgJobRunRate.
7201 * These settings should be global to all wikis.
7204 $wgJobBackoffThrottling = [];
7207 * Make job runners commit changes for slave-lag prone jobs one job at a time.
7208 * This is useful if there are many job workers that race on slave lag checks.
7209 * If set, jobs taking this many seconds of DB write time have serialized commits.
7211 * Note that affected jobs may have worse lock contention. Also, if they affect
7212 * several DBs at once they may have a smaller chance of being atomic due to the
7213 * possibility of connection loss while queueing up to commit. Affected jobs may
7214 * also fail due to the commit lock acquisition timeout.
7219 $wgJobSerialCommitThreshold = false;
7222 * Map of job types to configuration arrays.
7223 * This determines which queue class and storage system is used for each job type.
7224 * Job types that do not have explicit configuration will use the 'default' config.
7225 * These settings should be global to all wikis.
7228 'default' => [ 'class' => 'JobQueueDB', 'order' => 'random', 'claimTTL' => 3600 ],
7232 * Which aggregator to use for tracking which queues have jobs.
7233 * These settings should be global to all wikis.
7235 $wgJobQueueAggregator = [
7236 'class' => 'JobQueueAggregatorNull'
7240 * Additional functions to be performed with updateSpecialPages.
7241 * Expensive Querypages are already updated.
7243 $wgSpecialPageCacheUpdates = [
7244 'Statistics' => [ 'SiteStatsUpdate', 'cacheUpdate' ]
7248 * Hooks that are used for outputting exceptions. Format is:
7249 * $wgExceptionHooks[] = $funcname
7251 * $wgExceptionHooks[] = [ $class, $funcname ]
7252 * Hooks should return strings or false
7254 $wgExceptionHooks = [];
7257 * Page property link table invalidation lists. When a page property
7258 * changes, this may require other link tables to be updated (eg
7259 * adding __HIDDENCAT__ means the hiddencat tracking category will
7260 * have been added, so the categorylinks table needs to be rebuilt).
7261 * This array can be added to by extensions.
7263 $wgPagePropLinkInvalidations = [
7264 'hiddencat' => 'categorylinks',
7267 /** @} */ # End extensions }
7269 /*************************************************************************//**
7275 * Use experimental, DMOZ-like category browser
7277 $wgUseCategoryBrowser = false;
7280 * On category pages, show thumbnail gallery for images belonging to that
7281 * category instead of listing them as articles.
7283 $wgCategoryMagicGallery = true;
7286 * Paging limit for categories
7288 $wgCategoryPagingLimit = 200;
7291 * Specify how category names should be sorted, when listed on a category page.
7292 * A sorting scheme is also known as a collation.
7294 * Available values are:
7296 * - uppercase: Converts the category name to upper case, and sorts by that.
7298 * - identity: Does no conversion. Sorts by binary value of the string.
7300 * - uca-default: Provides access to the Unicode Collation Algorithm with
7301 * the default element table. This is a compromise collation which sorts
7302 * all languages in a mediocre way. However, it is better than "uppercase".
7304 * To use the uca-default collation, you must have PHP's intl extension
7305 * installed. See http://php.net/manual/en/intl.setup.php . The details of the
7306 * resulting collation will depend on the version of ICU installed on the
7309 * After you change this, you must run maintenance/updateCollation.php to fix
7310 * the sort keys in the database.
7312 * Extensions can define there own collations by subclassing Collation
7313 * and using the Collation::factory hook.
7315 $wgCategoryCollation = 'uppercase';
7317 /** @} */ # End categories }
7319 /*************************************************************************//**
7325 * The logging system has two levels: an event type, which describes the
7326 * general category and can be viewed as a named subset of all logs; and
7327 * an action, which is a specific kind of event that can exist in that
7348 * This restricts log access to those who have a certain right
7349 * Users without this will not see it in the option menu and can not view it
7350 * Restricted logs are not added to recent changes
7351 * Logs should remain non-transcludable
7352 * Format: logtype => permissiontype
7354 $wgLogRestrictions = [
7355 'suppress' => 'suppressionlog'
7359 * Show/hide links on Special:Log will be shown for these log types.
7361 * This is associative array of log type => boolean "hide by default"
7363 * See $wgLogTypes for a list of available log types.
7367 * $wgFilterLogTypes = [ 'move' => true, 'import' => false ];
7370 * Will display show/hide links for the move and import logs. Move logs will be
7371 * hidden by default unless the link is clicked. Import logs will be shown by
7372 * default, and hidden when the link is clicked.
7374 * A message of the form log-show-hide-[type] should be added, and will be used
7375 * for the link text.
7377 $wgFilterLogTypes = [
7383 * Lists the message key string for each log type. The localized messages
7384 * will be listed in the user interface.
7386 * Extensions with custom log types may add to this array.
7388 * @since 1.19, if you follow the naming convention log-name-TYPE,
7389 * where TYPE is your log type, yoy don't need to use this array.
7392 '' => 'all-logs-page',
7393 'block' => 'blocklogpage',
7394 'protect' => 'protectlogpage',
7395 'rights' => 'rightslog',
7396 'delete' => 'dellogpage',
7397 'upload' => 'uploadlogpage',
7398 'move' => 'movelogpage',
7399 'import' => 'importlogpage',
7400 'patrol' => 'patrol-log-page',
7401 'merge' => 'mergelog',
7402 'suppress' => 'suppressionlog',
7406 * Lists the message key string for descriptive text to be shown at the
7407 * top of each log type.
7409 * Extensions with custom log types may add to this array.
7411 * @since 1.19, if you follow the naming convention log-description-TYPE,
7412 * where TYPE is your log type, yoy don't need to use this array.
7415 '' => 'alllogstext',
7416 'block' => 'blocklogtext',
7417 'delete' => 'dellogpagetext',
7418 'import' => 'importlogpagetext',
7419 'merge' => 'mergelogpagetext',
7420 'move' => 'movelogpagetext',
7421 'patrol' => 'patrol-log-header',
7422 'protect' => 'protectlogtext',
7423 'rights' => 'rightslogtext',
7424 'suppress' => 'suppressionlogtext',
7425 'upload' => 'uploadlogpagetext',
7429 * Lists the message key string for formatting individual events of each
7430 * type and action when listed in the logs.
7432 * Extensions with custom log types may add to this array.
7437 * The same as above, but here values are names of classes,
7439 * @see LogPage::actionText
7442 $wgLogActionsHandlers = [
7443 'block/block' => 'BlockLogFormatter',
7444 'block/reblock' => 'BlockLogFormatter',
7445 'block/unblock' => 'BlockLogFormatter',
7446 'contentmodel/change' => 'ContentModelLogFormatter',
7447 'contentmodel/new' => 'ContentModelLogFormatter',
7448 'delete/delete' => 'DeleteLogFormatter',
7449 'delete/event' => 'DeleteLogFormatter',
7450 'delete/restore' => 'DeleteLogFormatter',
7451 'delete/revision' => 'DeleteLogFormatter',
7452 'import/interwiki' => 'ImportLogFormatter',
7453 'import/upload' => 'ImportLogFormatter',
7454 'managetags/activate' => 'LogFormatter',
7455 'managetags/create' => 'LogFormatter',
7456 'managetags/deactivate' => 'LogFormatter',
7457 'managetags/delete' => 'LogFormatter',
7458 'merge/merge' => 'MergeLogFormatter',
7459 'move/move' => 'MoveLogFormatter',
7460 'move/move_redir' => 'MoveLogFormatter',
7461 'patrol/patrol' => 'PatrolLogFormatter',
7462 'patrol/autopatrol' => 'PatrolLogFormatter',
7463 'protect/modify' => 'ProtectLogFormatter',
7464 'protect/move_prot' => 'ProtectLogFormatter',
7465 'protect/protect' => 'ProtectLogFormatter',
7466 'protect/unprotect' => 'ProtectLogFormatter',
7467 'rights/autopromote' => 'RightsLogFormatter',
7468 'rights/rights' => 'RightsLogFormatter',
7469 'suppress/block' => 'BlockLogFormatter',
7470 'suppress/delete' => 'DeleteLogFormatter',
7471 'suppress/event' => 'DeleteLogFormatter',
7472 'suppress/reblock' => 'BlockLogFormatter',
7473 'suppress/revision' => 'DeleteLogFormatter',
7474 'tag/update' => 'TagLogFormatter',
7475 'upload/overwrite' => 'UploadLogFormatter',
7476 'upload/revert' => 'UploadLogFormatter',
7477 'upload/upload' => 'UploadLogFormatter',
7481 * List of log types that can be filtered by action types
7483 * To each action is associated the list of log_action
7484 * subtypes to search for, usually one, but not necessarily so
7485 * Extensions may append to this array
7488 $wgActionFilteredLogs = [
7490 'block' => [ 'block' ],
7491 'reblock' => [ 'reblock' ],
7492 'unblock' => [ 'unblock' ],
7495 'change' => [ 'change' ],
7499 'delete' => [ 'delete' ],
7500 'restore' => [ 'restore' ],
7501 'event' => [ 'event' ],
7502 'revision' => [ 'revision' ],
7505 'interwiki' => [ 'interwiki' ],
7506 'upload' => [ 'upload' ],
7509 'create' => [ 'create' ],
7510 'delete' => [ 'delete' ],
7511 'activate' => [ 'activate' ],
7512 'deactivate' => [ 'deactivate' ],
7515 'move' => [ 'move' ],
7516 'move_redir' => [ 'move_redir' ],
7519 'create' => [ 'create', 'newusers' ],
7520 'create2' => [ 'create2' ],
7521 'autocreate' => [ 'autocreate' ],
7522 'byemail' => [ 'byemail' ],
7525 'patrol' => [ 'patrol' ],
7526 'autopatrol' => [ 'autopatrol' ],
7529 'protect' => [ 'protect' ],
7530 'modify' => [ 'modify' ],
7531 'unprotect' => [ 'unprotect' ],
7532 'move_prot' => [ 'move_prot' ],
7535 'rights' => [ 'rights' ],
7536 'autopromote' => [ 'autopromote' ],
7539 'event' => [ 'event' ],
7540 'revision' => [ 'revision' ],
7541 'delete' => [ 'delete' ],
7542 'block' => [ 'block' ],
7543 'reblock' => [ 'reblock' ],
7546 'upload' => [ 'upload' ],
7547 'overwrite' => [ 'overwrite' ],
7552 * Maintain a log of newusers at Log/newusers?
7554 $wgNewUserLog = true;
7556 /** @} */ # end logging }
7558 /*************************************************************************//**
7559 * @name Special pages (general and miscellaneous)
7564 * Allow special page inclusions such as {{Special:Allpages}}
7566 $wgAllowSpecialInclusion = true;
7569 * Set this to an array of special page names to prevent
7570 * maintenance/updateSpecialPages.php from updating those pages.
7572 $wgDisableQueryPageUpdate = false;
7575 * On Special:Unusedimages, consider images "used", if they are put
7576 * into a category. Default (false) is not to count those as used.
7578 $wgCountCategorizedImagesAsUsed = false;
7581 * Maximum number of links to a redirect page listed on
7582 * Special:Whatlinkshere/RedirectDestination
7584 $wgMaxRedirectLinksRetrieved = 500;
7586 /** @} */ # end special pages }
7588 /*************************************************************************//**
7594 * Array of allowed values for the "title=foo&action=<action>" parameter. Syntax is:
7595 * 'foo' => 'ClassName' Load the specified class which subclasses Action
7596 * 'foo' => true Load the class FooAction which subclasses Action
7597 * If something is specified in the getActionOverrides()
7598 * of the relevant Page object it will be used
7599 * instead of the default class.
7600 * 'foo' => false The action is disabled; show an error message
7601 * Unsetting core actions will probably cause things to complain loudly.
7607 'editchangetags' => 'SpecialPageAction',
7610 'markpatrolled' => true,
7616 'revisiondelete' => 'SpecialPageAction',
7619 'unprotect' => true,
7625 /** @} */ # end actions }
7627 /*************************************************************************//**
7628 * @name Robot (search engine crawler) policy
7629 * See also $wgNoFollowLinks.
7634 * Default robot policy. The default policy is to encourage indexing and fol-
7635 * lowing of links. It may be overridden on a per-namespace and/or per-page
7638 $wgDefaultRobotPolicy = 'index,follow';
7641 * Robot policies per namespaces. The default policy is given above, the array
7642 * is made of namespace constants as defined in includes/Defines.php. You can-
7643 * not specify a different default policy for NS_SPECIAL: it is always noindex,
7644 * nofollow. This is because a number of special pages (e.g., ListPages) have
7645 * many permutations of options that display the same data under redundant
7646 * URLs, so search engine spiders risk getting lost in a maze of twisty special
7647 * pages, all alike, and never reaching your actual content.
7651 * $wgNamespaceRobotPolicies = [ NS_TALK => 'noindex' ];
7654 $wgNamespaceRobotPolicies = [];
7657 * Robot policies per article. These override the per-namespace robot policies.
7658 * Must be in the form of an array where the key part is a properly canonicalised
7659 * text form title and the value is a robot policy.
7663 * $wgArticleRobotPolicies = [
7664 * 'Main Page' => 'noindex,follow',
7665 * 'User:Bob' => 'index,follow',
7669 * @par Example that DOES NOT WORK because the names are not canonical text
7672 * $wgArticleRobotPolicies = [
7673 * # Underscore, not space!
7674 * 'Main_Page' => 'noindex,follow',
7675 * # "Project", not the actual project name!
7676 * 'Project:X' => 'index,follow',
7677 * # Needs to be "Abc", not "abc" (unless $wgCapitalLinks is false for that namespace)!
7678 * 'abc' => 'noindex,nofollow'
7682 $wgArticleRobotPolicies = [];
7685 * An array of namespace keys in which the __INDEX__/__NOINDEX__ magic words
7686 * will not function, so users can't decide whether pages in that namespace are
7687 * indexed by search engines. If set to null, default to $wgContentNamespaces.
7691 * $wgExemptFromUserRobotsControl = [ NS_MAIN, NS_TALK, NS_PROJECT ];
7694 $wgExemptFromUserRobotsControl = null;
7696 /** @} */ # End robot policy }
7698 /************************************************************************//**
7699 * @name AJAX and API
7700 * Note: The AJAX entry point which this section refers to is gradually being
7701 * replaced by the API entry point, api.php. They are essentially equivalent.
7702 * Both of them are used for dynamic client-side features, via XHR.
7707 * Enable the MediaWiki API for convenient access to
7708 * machine-readable data via api.php
7710 * See https://www.mediawiki.org/wiki/API
7712 $wgEnableAPI = true;
7715 * Allow the API to be used to perform write operations
7716 * (page edits, rollback, etc.) when an authorised user
7719 $wgEnableWriteAPI = true;
7723 * WARNING: SECURITY THREAT - debug use only
7725 * Disables many security checks in the API for debugging purposes.
7726 * This flag should never be used on the production servers, as it introduces
7727 * a number of potential security holes. Even when enabled, the validation
7728 * will still be performed, but instead of failing, API will return a warning.
7729 * Also, there will always be a warning notifying that this flag is set.
7730 * At this point, the flag allows GET requests to go through for modules
7735 $wgDebugAPI = false;
7738 * API module extensions.
7740 * Associative array mapping module name to modules specs;
7741 * Each module spec is an associative array containing at least
7742 * the 'class' key for the module's class, and optionally a
7743 * 'factory' key for the factory function to use for the module.
7745 * That factory function will be called with two parameters,
7746 * the parent module (an instance of ApiBase, usually ApiMain)
7747 * and the name the module was registered under. The return
7748 * value must be an instance of the class given in the 'class'
7751 * For backward compatibility, the module spec may also be a
7752 * simple string containing the module's class name. In that
7753 * case, the class' constructor will be called with the parent
7754 * module and module name as parameters, as described above.
7756 * Examples for registering API modules:
7759 * $wgAPIModules['foo'] = 'ApiFoo';
7760 * $wgAPIModules['bar'] = [
7761 * 'class' => 'ApiBar',
7762 * 'factory' => function( $main, $name ) { ... }
7764 * $wgAPIModules['xyzzy'] = [
7765 * 'class' => 'ApiXyzzy',
7766 * 'factory' => [ 'XyzzyFactory', 'newApiModule' ]
7770 * Extension modules may override the core modules.
7771 * See ApiMain::$Modules for a list of the core modules.
7776 * API format module extensions.
7777 * Associative array mapping format module name to module specs (see $wgAPIModules).
7778 * Extension modules may override the core modules.
7780 * See ApiMain::$Formats for a list of the core format modules.
7782 $wgAPIFormatModules = [];
7785 * API Query meta module extensions.
7786 * Associative array mapping meta module name to module specs (see $wgAPIModules).
7787 * Extension modules may override the core modules.
7789 * See ApiQuery::$QueryMetaModules for a list of the core meta modules.
7791 $wgAPIMetaModules = [];
7794 * API Query prop module extensions.
7795 * Associative array mapping prop module name to module specs (see $wgAPIModules).
7796 * Extension modules may override the core modules.
7798 * See ApiQuery::$QueryPropModules for a list of the core prop modules.
7800 $wgAPIPropModules = [];
7803 * API Query list module extensions.
7804 * Associative array mapping list module name to module specs (see $wgAPIModules).
7805 * Extension modules may override the core modules.
7807 * See ApiQuery::$QueryListModules for a list of the core list modules.
7809 $wgAPIListModules = [];
7812 * Maximum amount of rows to scan in a DB query in the API
7813 * The default value is generally fine
7815 $wgAPIMaxDBRows = 5000;
7818 * The maximum size (in bytes) of an API result.
7819 * @warning Do not set this lower than $wgMaxArticleSize*1024
7821 $wgAPIMaxResultSize = 8388608;
7824 * The maximum number of uncached diffs that can be retrieved in one API
7825 * request. Set this to 0 to disable API diffs altogether
7827 $wgAPIMaxUncachedDiffs = 1;
7830 * Maximum amount of DB lag on a majority of DB slaves to tolerate
7831 * before forcing bots to retry any write requests via API errors.
7832 * This should be lower than the 'max lag' value in $wgLBFactoryConf.
7834 $wgAPIMaxLagThreshold = 7;
7837 * Log file or URL (TCP or UDP) to log API requests to, or false to disable
7838 * API request logging
7840 $wgAPIRequestLog = false;
7843 * Set the timeout for the API help text cache. If set to 0, caching disabled
7845 $wgAPICacheHelpTimeout = 60 * 60;
7848 * The ApiQueryQueryPages module should skip pages that are redundant to true
7851 $wgAPIUselessQueryPages = [
7852 'MIMEsearch', // aiprop=mime
7853 'LinkSearch', // list=exturlusage
7854 'FileDuplicateSearch', // prop=duplicatefiles
7858 * Enable AJAX framework
7863 * List of Ajax-callable functions.
7864 * Extensions acting as Ajax callbacks must register here
7865 * @deprecated (officially) since 1.27; use the API instead
7867 $wgAjaxExportList = [];
7870 * Enable AJAX check for file overwrite, pre-upload
7872 $wgAjaxUploadDestCheck = true;
7875 * Enable previewing licences via AJAX. Also requires $wgEnableAPI to be true.
7877 $wgAjaxLicensePreview = true;
7880 * Have clients send edits to be prepared when filling in edit summaries.
7881 * This gives the server a head start on the expensive parsing operation.
7883 $wgAjaxEditStash = true;
7886 * Settings for incoming cross-site AJAX requests:
7887 * Newer browsers support cross-site AJAX when the target resource allows requests
7888 * from the origin domain by the Access-Control-Allow-Origin header.
7889 * This is currently only used by the API (requests to api.php)
7890 * $wgCrossSiteAJAXdomains can be set using a wildcard syntax:
7892 * - '*' matches any number of characters
7893 * - '?' matches any 1 character
7897 * $wgCrossSiteAJAXdomains = [
7898 * 'www.mediawiki.org',
7899 * '*.wikipedia.org',
7900 * '*.wikimedia.org',
7901 * '*.wiktionary.org',
7905 $wgCrossSiteAJAXdomains = [];
7908 * Domains that should not be allowed to make AJAX requests,
7909 * even if they match one of the domains allowed by $wgCrossSiteAJAXdomains
7910 * Uses the same syntax as $wgCrossSiteAJAXdomains
7912 $wgCrossSiteAJAXdomainExceptions = [];
7914 /** @} */ # End AJAX and API }
7916 /************************************************************************//**
7917 * @name Shell and process control
7922 * Maximum amount of virtual memory available to shell processes under linux, in KB.
7924 $wgMaxShellMemory = 307200;
7927 * Maximum file size created by shell processes under linux, in KB
7928 * ImageMagick convert for example can be fairly hungry for scratch space
7930 $wgMaxShellFileSize = 102400;
7933 * Maximum CPU time in seconds for shell processes under Linux
7935 $wgMaxShellTime = 180;
7938 * Maximum wall clock time (i.e. real time, of the kind the clock on the wall
7939 * would measure) in seconds for shell processes under Linux
7941 $wgMaxShellWallClockTime = 180;
7944 * Under Linux: a cgroup directory used to constrain memory usage of shell
7945 * commands. The directory must be writable by the user which runs MediaWiki.
7947 * If specified, this is used instead of ulimit, which is inaccurate, and
7948 * causes malloc() to return NULL, which exposes bugs in C applications, making
7949 * them segfault or deadlock.
7951 * A wrapper script will create a cgroup for each shell command that runs, as
7952 * a subgroup of the specified cgroup. If the memory limit is exceeded, the
7953 * kernel will send a SIGKILL signal to a process in the subgroup.
7957 * mkdir -p /sys/fs/cgroup/memory/mediawiki
7958 * mkdir -m 0777 /sys/fs/cgroup/memory/mediawiki/job
7959 * echo '$wgShellCgroup = "/sys/fs/cgroup/memory/mediawiki/job";' >> LocalSettings.php
7962 * The reliability of cgroup cleanup can be improved by installing a
7963 * notify_on_release script in the root cgroup, see e.g.
7964 * https://gerrit.wikimedia.org/r/#/c/40784
7966 $wgShellCgroup = false;
7969 * Executable path of the PHP cli binary (php/php5). Should be set up on install.
7971 $wgPhpCli = '/usr/bin/php';
7974 * Locale for LC_CTYPE, to work around http://bugs.php.net/bug.php?id=45132
7975 * For Unix-like operating systems, set this to to a locale that has a UTF-8
7976 * character set. Only the character set is relevant.
7978 $wgShellLocale = 'en_US.utf8';
7980 /** @} */ # End shell }
7982 /************************************************************************//**
7988 * Timeout for HTTP requests done internally, in seconds.
7990 $wgHTTPTimeout = 25;
7993 * Timeout for Asynchronous (background) HTTP requests, in seconds.
7995 $wgAsyncHTTPTimeout = 25;
7998 * Proxy to use for CURL requests.
8000 $wgHTTPProxy = false;
8003 * Local virtual hosts.
8005 * This lists domains that are configured as virtual hosts on the same machine.
8006 * If a request is to be made to a domain listed here, or any subdomain thereof,
8007 * then no proxy will be used.
8008 * Command-line scripts are not affected by this setting and will always use
8009 * proxy if it is configured.
8012 $wgLocalVirtualHosts = [];
8015 * Timeout for connections done internally (in seconds)
8016 * Only works for curl
8018 $wgHTTPConnectTimeout = 5e0
;
8020 /** @} */ # End HTTP client }
8022 /************************************************************************//**
8028 * Number of jobs to perform per request. May be less than one in which case
8029 * jobs are performed probabalistically. If this is zero, jobs will not be done
8030 * during ordinary apache requests. In this case, maintenance/runJobs.php should
8031 * be run periodically.
8036 * When $wgJobRunRate > 0, try to run jobs asynchronously, spawning a new process
8037 * to handle the job execution, instead of blocking the request until the job
8038 * execution finishes.
8041 $wgRunJobsAsync = true;
8044 * Number of rows to update per job
8046 $wgUpdateRowsPerJob = 300;
8049 * Number of rows to update per query
8051 $wgUpdateRowsPerQuery = 100;
8053 /** @} */ # End job queue }
8055 /************************************************************************//**
8056 * @name Miscellaneous
8061 * Name of the external diff engine to use. Supported values:
8062 * * string: path to an external diff executable
8063 * * false: wikidiff2 PHP/HHVM module if installed, otherwise the default PHP implementation
8064 * * 'wikidiff', 'wikidiff2', and 'wikidiff3' are treated as false for backwards compatibility
8066 $wgExternalDiffEngine = false;
8069 * Disable redirects to special pages and interwiki redirects, which use a 302
8070 * and have no "redirected from" link.
8072 * @note This is only for articles with #REDIRECT in them. URL's containing a
8073 * local interwiki prefix (or a non-canonical special page name) are still hard
8074 * redirected regardless of this setting.
8076 $wgDisableHardRedirects = false;
8079 * LinkHolderArray batch size
8082 $wgLinkHolderBatchSize = 1000;
8085 * By default MediaWiki does not register links pointing to same server in
8086 * externallinks dataset, use this value to override:
8088 $wgRegisterInternalExternals = false;
8091 * Maximum number of pages to move at once when moving subpages with a page.
8093 $wgMaximumMovedPages = 100;
8096 * Fix double redirects after a page move.
8097 * Tends to conflict with page move vandalism, use only on a private wiki.
8099 $wgFixDoubleRedirects = false;
8102 * Allow redirection to another page when a user logs in.
8103 * To enable, set to a string like 'Main Page'
8105 $wgRedirectOnLogin = null;
8108 * Configuration for processing pool control, for use in high-traffic wikis.
8109 * An implementation is provided in the PoolCounter extension.
8111 * This configuration array maps pool types to an associative array. The only
8112 * defined key in the associative array is "class", which gives the class name.
8113 * The remaining elements are passed through to the class as constructor
8118 * $wgPoolCounterConf = [ 'ArticleView' => [
8119 * 'class' => 'PoolCounter_Client',
8120 * 'timeout' => 15, // wait timeout in seconds
8121 * 'workers' => 5, // maximum number of active threads in each pool
8122 * 'maxqueue' => 50, // maximum number of total threads in each pool
8123 * ... any extension-specific options...
8127 $wgPoolCounterConf = null;
8130 * To disable file delete/restore temporarily
8132 $wgUploadMaintenance = false;
8135 * Associative array mapping namespace IDs to the name of the content model pages in that namespace
8136 * should have by default (use the CONTENT_MODEL_XXX constants). If no special content type is
8137 * defined for a given namespace, pages in that namespace will use the CONTENT_MODEL_WIKITEXT
8138 * (except for the special case of JS and CS pages).
8142 $wgNamespaceContentModels = [];
8145 * How to react if a plain text version of a non-text Content object is requested using
8146 * ContentHandler::getContentText():
8148 * * 'ignore': return null
8149 * * 'fail': throw an MWException
8150 * * 'serialize': serialize to default format
8154 $wgContentHandlerTextFallback = 'ignore';
8157 * Set to false to disable use of the database fields introduced by the ContentHandler facility.
8158 * This way, the ContentHandler facility can be used without any additional information in the
8159 * database. A page's content model is then derived solely from the page's title. This however
8160 * means that changing a page's default model (e.g. using $wgNamespaceContentModels) will break
8161 * the page and/or make the content inaccessible. This also means that pages can not be moved to
8162 * a title that would default to a different content model.
8164 * Overall, with $wgContentHandlerUseDB = false, no database updates are needed, but content
8165 * handling is less robust and less flexible.
8169 $wgContentHandlerUseDB = true;
8172 * Determines which types of text are parsed as wikitext. This does not imply that these kinds
8173 * of texts are also rendered as wikitext, it only means that links, magic words, etc will have
8174 * the effect on the database they would have on a wikitext page.
8176 * @todo On the long run, it would be nice to put categories etc into a separate structure,
8177 * or at least parse only the contents of comments in the scripts.
8181 $wgTextModelsToParse = [
8182 CONTENT_MODEL_WIKITEXT
, // Just for completeness, wikitext will always be parsed.
8183 CONTENT_MODEL_JAVASCRIPT
, // Make categories etc work, people put them into comments.
8184 CONTENT_MODEL_CSS
, // Make categories etc work, people put them into comments.
8188 * Whether the user must enter their password to change their e-mail address
8192 $wgRequirePasswordforEmailChange = true;
8195 * Register handlers for specific types of sites.
8200 'mediawiki' => 'MediaWikiSite',
8204 * Whether the page_props table has a pp_sortkey column. Set to false in case
8205 * the respective database schema change was not applied.
8208 $wgPagePropsHaveSortkey = true;
8211 * Port where you have HTTPS running
8212 * Supports HTTPS on non-standard ports
8219 * Secret for session storage.
8220 * This should be set in LocalSettings.php, otherwise wgSecretKey will
8224 $wgSessionSecret = false;
8227 * If for some reason you can't install the PHP OpenSSL or mcrypt extensions,
8228 * you can set this to true to make MediaWiki work again at the cost of storing
8229 * sensitive session data insecurely. But it would be much more secure to just
8230 * install the OpenSSL extension.
8233 $wgSessionInsecureSecrets = false;
8236 * Secret for hmac-based key derivation function (fast,
8237 * cryptographically secure random numbers).
8238 * This should be set in LocalSettings.php, otherwise wgSecretKey will
8240 * See also: $wgHKDFAlgorithm
8243 $wgHKDFSecret = false;
8246 * Algorithm for hmac-based key derivation function (fast,
8247 * cryptographically secure random numbers).
8248 * See also: $wgHKDFSecret
8251 $wgHKDFAlgorithm = 'sha256';
8254 * Enable page language feature
8255 * Allows setting page language in database
8259 $wgPageLanguageUseDB = false;
8262 * Global configuration variable for Virtual REST Services.
8263 * Parameters for different services are to be declared inside
8264 * $wgVirtualRestConfig['modules'], which is to be treated as an associative
8265 * array. Global parameters will be merged with service-specific ones. The
8266 * result will then be passed to VirtualRESTService::__construct() in the
8269 * Example config for Parsoid:
8271 * $wgVirtualRestConfig['modules']['parsoid'] = [
8272 * 'url' => 'http://localhost:8000',
8273 * 'prefix' => 'enwiki',
8274 * 'domain' => 'en.wikipedia.org',
8280 $wgVirtualRestConfig = [
8283 # Timeout in seconds
8285 # 'domain' is set to $wgCanonicalServer in Setup.php
8286 'forwardCookies' => false,
8292 * Controls whether zero-result search queries with suggestions should display results for
8293 * these suggestions.
8298 $wgSearchRunSuggestedQuery = true;
8301 * Where popular password file is located.
8303 * Default in core contains 50,000 most popular. This config
8304 * allows you to change which file, in case you want to generate
8305 * a password file with > 50000 entries in it.
8307 * @see maintenance/createCommonPasswordCdb.php
8309 * @var string path to file
8311 $wgPopularPasswordFile = __DIR__
. '/../serialized/commonpasswords.cdb';
8314 * Max time (in seconds) a user-generated transaction can spend in writes.
8315 * If exceeded, the transaction is rolled back with an error instead of being committed.
8317 * @var int|bool Disabled if false
8320 $wgMaxUserDBWriteDuration = false;
8323 * Mapping of event channels (or channel categories) to EventRelayer configuration.
8325 * By setting up a PubSub system (like Kafka) and enabling a corresponding EventRelayer class
8326 * that uses it, MediaWiki can broadcast events to all subscribers. Certain features like WAN
8327 * cache purging and CDN cache purging will emit events to this system. Appropriate listers can
8328 * subscribe to the channel and take actions based on the events. For example, a local daemon
8329 * can run on each CDN cache node and perfom local purges based on the URL purge channel events.
8331 * Some extensions may want to use "channel categories" so that different channels can also share
8332 * the same custom relayer instance (e.g. when it's likely to be overriden). They can use
8333 * EventRelayerGroup::getRelayer() based on the category but call notify() on various different
8334 * actual channels. One reason for this would be that some system have very different performance
8335 * vs durability needs, so one system (e.g. Kafka) may not be suitable for all uses.
8337 * The 'default' key is for all channels (or channel categories) without an explicit entry here.
8341 $wgEventRelayerConfig = [
8343 'class' => 'EventRelayerNull',
8348 * For really cool vim folding this needs to be at the end:
8349 * vim: foldmarker=@{,@} foldmethod=marker