3 * Default values for MediaWiki configuration settings.
9 * To customize your installation, edit "LocalSettings.php". If you make
10 * changes here, they will be lost on next upgrade of MediaWiki!
12 * In this file, variables whose default values depend on other
13 * variables are set to false. The actual default value of these variables
14 * will only be set in Setup.php, taking into account any custom settings
15 * performed in LocalSettings.php.
17 * Documentation is in the source and on:
18 * https://www.mediawiki.org/wiki/Manual:Configuration_settings
20 * @warning Note: this (and other things) will break if the autoloader is not
21 * enabled. Please include includes/AutoLoader.php before including this file.
23 * This program is free software; you can redistribute it and/or modify
24 * it under the terms of the GNU General Public License as published by
25 * the Free Software Foundation; either version 2 of the License, or
26 * (at your option) any later version.
28 * This program is distributed in the hope that it will be useful,
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31 * GNU General Public License for more details.
33 * You should have received a copy of the GNU General Public License along
34 * with this program; if not, write to the Free Software Foundation, Inc.,
35 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
36 * http://www.gnu.org/copyleft/gpl.html
40 use MediaWiki\MediaWikiServices
;
43 * @cond file_level_code
44 * This is not a valid entry point, perform no further processing unless
45 * MEDIAWIKI is defined
47 if ( !defined( 'MEDIAWIKI' ) ) {
48 echo "This file is part of MediaWiki and is not a valid entry point\n";
55 * wgConf hold the site configuration.
56 * Not used for much in a default install.
59 $wgConf = new SiteConfiguration
;
62 * Registry of factory functions to create config objects:
63 * The 'main' key must be set, and the value should be a valid
68 'main' => 'GlobalVarConfig::newInstance'
72 * MediaWiki version number
75 $wgVersion = '1.34.0-alpha';
78 * Name of the site. It must be changed in LocalSettings.php
80 $wgSitename = 'MediaWiki';
83 * When the wiki is running behind a proxy and this is set to true, assumes that the proxy exposes
84 * the wiki on the standard ports (443 for https and 80 for http).
88 $wgAssumeProxiesUseDefaultProtocolPorts = true;
95 * $wgServer = 'http://example.com';
98 * This is usually detected correctly by MediaWiki. If MediaWiki detects the
99 * wrong server, it will redirect incorrectly after you save a page. In that
100 * case, set this variable to fix it.
102 * If you want to use protocol-relative URLs on your wiki, set this to a
103 * protocol-relative URL like '//example.com' and set $wgCanonicalServer
104 * to a fully qualified URL.
106 $wgServer = WebRequest
::detectServer();
109 * Canonical URL of the server, to use in IRC feeds and notification e-mails.
110 * Must be fully qualified, even if $wgServer is protocol-relative.
112 * Defaults to $wgServer, expanded to a fully qualified http:// URL if needed.
115 $wgCanonicalServer = false;
118 * Server name. This is automatically computed by parsing the bare
119 * hostname out of $wgCanonicalServer. It should not be customized.
122 $wgServerName = false;
124 /************************************************************************//**
125 * @name Script path settings
130 * The path we should point to.
131 * It might be a virtual path in case with use apache mod_rewrite for example.
133 * This *needs* to be set correctly.
135 * Other paths will be set to defaults based on it unless they are directly
136 * set in LocalSettings.php
138 $wgScriptPath = '/wiki';
141 * Whether to support URLs like index.php/Page_title These often break when PHP
142 * is set up in CGI mode. PATH_INFO *may* be correct if cgi.fix_pathinfo is set,
143 * but then again it may not; lighttpd converts incoming path data to lowercase
144 * on systems with case-insensitive filesystems, and there have been reports of
145 * problems on Apache as well.
147 * To be safe we'll continue to keep it off by default.
149 * Override this to false if $_SERVER['PATH_INFO'] contains unexpectedly
150 * incorrect garbage, or to true if it is really correct.
152 * The default $wgArticlePath will be set based on this value at runtime, but if
153 * you have customized it, having this incorrectly set to true can cause
154 * redirect loops when "pretty URLs" are used.
157 $wgUsePathInfo = ( strpos( PHP_SAPI
, 'cgi' ) === false ) &&
158 ( strpos( PHP_SAPI
, 'apache2filter' ) === false ) &&
159 ( strpos( PHP_SAPI
, 'isapi' ) === false );
163 /************************************************************************//**
164 * @name URLs and file paths
166 * These various web and file path variables are set to their defaults
167 * in Setup.php if they are not explicitly set from LocalSettings.php.
169 * These will relatively rarely need to be set manually, unless you are
170 * splitting style sheets or images outside the main document root.
172 * In this section, a "path" is usually a host-relative URL, i.e. a URL without
173 * the host part, that starts with a slash. In most cases a full URL is also
174 * acceptable. A "directory" is a local file path.
176 * In both paths and directories, trailing slashes should not be included.
182 * The URL path to index.php.
184 * Defaults to "{$wgScriptPath}/index.php".
189 * The URL path to load.php.
191 * Defaults to "{$wgScriptPath}/load.php".
194 $wgLoadScript = false;
197 * The URL path to the REST API
198 * Defaults to "{$wgScriptPath}/rest.php"
204 * The URL path of the skins directory.
205 * Defaults to "{$wgResourceBasePath}/skins".
208 $wgStylePath = false;
209 $wgStyleSheetPath = &$wgStylePath;
212 * The URL path of the skins directory. Should not point to an external domain.
213 * Defaults to "{$wgScriptPath}/skins".
216 $wgLocalStylePath = false;
219 * The URL path of the extensions directory.
220 * Defaults to "{$wgResourceBasePath}/extensions".
223 $wgExtensionAssetsPath = false;
226 * Filesystem extensions directory.
227 * Defaults to "{$IP}/extensions".
230 $wgExtensionDirectory = "{$IP}/extensions";
233 * Filesystem stylesheets directory.
234 * Defaults to "{$IP}/skins".
237 $wgStyleDirectory = "{$IP}/skins";
240 * The URL path for primary article page views. This path should contain $1,
241 * which is replaced by the article title.
243 * Defaults to "{$wgScript}/$1" or "{$wgScript}?title=$1",
244 * depending on $wgUsePathInfo.
246 $wgArticlePath = false;
249 * The URL path for the images directory.
250 * Defaults to "{$wgScriptPath}/images".
252 $wgUploadPath = false;
255 * The filesystem path of the images directory. Defaults to "{$IP}/images".
257 $wgUploadDirectory = false;
260 * Directory where the cached page will be saved.
261 * Defaults to "{$wgUploadDirectory}/cache".
263 $wgFileCacheDirectory = false;
266 * The URL path of the wiki logo. The logo size should be 135x135 pixels.
267 * Defaults to "$wgResourceBasePath/resources/assets/wiki.png".
272 * Array with URL paths to HD versions of the wiki logo. The scaled logo size
273 * should be under 135x155 pixels.
274 * Only 1.5x and 2x versions are supported.
279 * "1.5x" => "path/to/1.5x_version.png",
280 * "2x" => "path/to/2x_version.png"
284 * SVG is also supported but when enabled, it
285 * disables 1.5x and 2x as svg will already
286 * be optimised for screen resolution.
291 * "svg" => "path/to/svg_version.svg",
300 * The URL path of the shortcut icon.
303 $wgFavicon = '/favicon.ico';
306 * The URL path of the icon for iPhone and iPod Touch web app bookmarks.
307 * Defaults to no icon.
310 $wgAppleTouchIcon = false;
313 * Value for the referrer policy meta tag.
314 * One or more of the values defined in the Referrer Policy specification:
315 * https://w3c.github.io/webappsec-referrer-policy/
316 * ('no-referrer', 'no-referrer-when-downgrade', 'same-origin',
317 * 'origin', 'strict-origin', 'origin-when-cross-origin',
318 * 'strict-origin-when-cross-origin', or 'unsafe-url')
319 * Setting it to false prevents the meta tag from being output
320 * (which results in falling back to the Referrer-Policy header,
321 * or 'no-referrer-when-downgrade' if that's not set either.)
322 * Setting it to an array (supported since 1.31) will create a meta tag for
323 * each value, in the reverse of the order (meaning that the first array element
324 * will be the default and the others used as fallbacks for browsers which do not
327 * @var array|string|bool
330 $wgReferrerPolicy = false;
333 * The local filesystem path to a temporary directory. This must not be web accessible.
335 * When this setting is set to false, its value will automatically be decided
336 * through the first call to wfTempDir(). See that method's implementation for
337 * the actual detection logic.
339 * To find the temporary path for the current wiki, developers must not use
340 * this variable directly. Use the global function wfTempDir() instead.
342 * The temporary directory is expected to be shared with other applications,
343 * including other MediaWiki instances (which might not run the same version
344 * or configution). When storing files here, take care to avoid conflicts
345 * with other instances of MediaWiki. For example, when caching the result
346 * of a computation, the file name should incorporate the input of the
347 * computation so that it cannot be confused for the result of a similar
348 * computation by another MediaWiki instance.
351 * @note Default changed to false in MediaWiki 1.20.
353 $wgTmpDirectory = false;
356 * If set, this URL is added to the start of $wgUploadPath to form a complete
360 $wgUploadBaseUrl = '';
363 * To enable remote on-demand scaling, set this to the thumbnail base URL.
364 * Full thumbnail URL will be like $wgUploadStashScalerBaseUrl/e/e6/Foo.jpg/123px-Foo.jpg
365 * where 'e6' are the first two characters of the MD5 hash of the file name.
366 * If $wgUploadStashScalerBaseUrl is set to false, thumbs are rendered locally as needed.
369 $wgUploadStashScalerBaseUrl = false;
372 * To set 'pretty' URL paths for actions other than
373 * plain page views, add to this array.
376 * Set pretty URL for the edit action:
378 * 'edit' => "$wgScriptPath/edit/$1"
381 * There must be an appropriate script or rewrite rule in place to handle these
389 /************************************************************************//**
390 * @name Files and file uploads
395 * Allow users to upload files.
397 * Use $wgLocalFileRepo to control how and where uploads are stored.
398 * Disabled by default as for security reasons.
399 * See <https://www.mediawiki.org/wiki/Manual:Configuring_file_uploads>.
403 $wgEnableUploads = false;
406 * The maximum age of temporary (incomplete) uploaded files
408 $wgUploadStashMaxAge = 6 * 3600; // 6 hours
411 * Allows to move images and other media files
413 $wgAllowImageMoving = true;
416 * Enable deferred upload tasks that use the job queue.
417 * Only enable this if job runners are set up for both the
418 * 'AssembleUploadChunks' and 'PublishStashedFile' job types.
420 * @note If you use suhosin, this setting is incompatible with
421 * suhosin.session.encrypt.
423 $wgEnableAsyncUploads = false;
426 * Additional characters that are not allowed in filenames. They are replaced with '-' when
427 * uploading. Like $wgLegalTitleChars, this is a regexp character class.
429 * Slashes and backslashes are disallowed regardless of this setting, but included here for
432 $wgIllegalFileChars = ":\\/\\\\";
435 * What directory to place deleted uploads in.
436 * Defaults to "{$wgUploadDirectory}/deleted".
438 $wgDeletedDirectory = false;
441 * Set this to true if you use img_auth and want the user to see details on why access failed.
443 $wgImgAuthDetails = false;
446 * Map of relative URL directories to match to internal mwstore:// base storage paths.
447 * For img_auth.php requests, everything after "img_auth.php/" is checked to see
448 * if starts with any of the prefixes defined here. The prefixes should not overlap.
449 * The prefix that matches has a corresponding storage path, which the rest of the URL
450 * is assumed to be relative to. The file at that path (or a 404) is send to the client.
453 * $wgImgAuthUrlPathMap['/timeline/'] = 'mwstore://local-fs/timeline-render/';
454 * The above maps ".../img_auth.php/timeline/X" to "mwstore://local-fs/timeline-render/".
455 * The name "local-fs" should correspond by name to an entry in $wgFileBackends.
457 * @see $wgFileBackends
459 $wgImgAuthUrlPathMap = [];
462 * File repository structures
464 * $wgLocalFileRepo is a single repository structure, and $wgForeignFileRepos is
465 * an array of such structures. Each repository structure is an associative
466 * array of properties configuring the repository.
468 * Properties required for all repos:
469 * - class The class name for the repository. May come from the core or an extension.
470 * The core repository classes are FileRepo, LocalRepo, ForeignDBRepo.
472 * - name A unique name for the repository (but $wgLocalFileRepo should be 'local').
473 * The name should consist of alpha-numeric characters.
474 * - backend A file backend name (see $wgFileBackends).
476 * For most core repos:
477 * - zones Associative array of zone names that each map to an array with:
478 * container : backend container name the zone is in
479 * directory : root path within container for the zone
480 * url : base URL to the root of the zone
481 * urlsByExt : map of file extension types to base URLs
482 * (useful for using a different cache for videos)
483 * Zones default to using "<repo name>-<zone name>" as the container name
484 * and default to using the container root as the zone's root directory.
485 * Nesting of zone locations within other zones should be avoided.
486 * - url Public zone URL. The 'zones' settings take precedence.
487 * - hashLevels The number of directory levels for hash-based division of files
488 * - thumbScriptUrl The URL for thumb.php (optional, not recommended)
489 * - transformVia404 Whether to skip media file transformation on parse and rely on a 404
491 * - initialCapital Equivalent to $wgCapitalLinks (or $wgCapitalLinkOverrides[NS_FILE],
492 * determines whether filenames implicitly start with a capital letter.
493 * The current implementation may give incorrect description page links
494 * when the local $wgCapitalLinks and initialCapital are mismatched.
495 * - pathDisclosureProtection
496 * May be 'paranoid' to remove all parameters from error messages, 'none' to
497 * leave the paths in unchanged, or 'simple' to replace paths with
498 * placeholders. Default for LocalRepo is 'simple'.
499 * - fileMode This allows wikis to set the file mode when uploading/moving files. Default
501 * - directory The local filesystem directory where public files are stored. Not used for
503 * - thumbDir The base thumbnail directory. Defaults to "<directory>/thumb".
504 * - thumbUrl The base thumbnail URL. Defaults to "<url>/thumb".
505 * - isPrivate Set this if measures should always be taken to keep the files private.
506 * One should not trust this to assure that the files are not web readable;
507 * the server configuration should be done manually depending on the backend.
509 * These settings describe a foreign MediaWiki installation. They are optional, and will be ignored
510 * for local repositories:
511 * - descBaseUrl URL of image description pages, e.g. https://en.wikipedia.org/wiki/File:
512 * - scriptDirUrl URL of the MediaWiki installation, equivalent to $wgScriptPath, e.g.
513 * https://en.wikipedia.org/w
514 * - articleUrl Equivalent to $wgArticlePath, e.g. https://en.wikipedia.org/wiki/$1
515 * - fetchDescription Fetch the text of the remote file description page and display them
517 * - abbrvThreshold File names over this size will use the short form of thumbnail names.
518 * Short thumbnail names only have the width, parameters, and the extension.
521 * - dbType, dbServer, dbUser, dbPassword, dbName, dbFlags
522 * equivalent to the corresponding member of $wgDBservers
523 * - tablePrefix Table prefix, the foreign wiki's $wgDBprefix
524 * - hasSharedCache Set to true if the foreign wiki's $wgMainCacheType is identical to,
525 * and accessible from, this wiki.
528 * - apibase Use for the foreign API's URL
529 * - apiThumbCacheExpiry How long to locally cache thumbs for
531 * If you leave $wgLocalFileRepo set to false, Setup will fill in appropriate values.
532 * Otherwise, set $wgLocalFileRepo to a repository structure as described above.
533 * If you set $wgUseInstantCommons to true, it will add an entry for Commons.
534 * If you set $wgForeignFileRepos to an array of repository structures, those will
535 * be searched after the local file repo.
536 * Otherwise, you will only have access to local media files.
538 * @see Setup.php for an example usage and default initialization.
540 $wgLocalFileRepo = false;
543 * Enable the use of files from one or more other wikis.
545 * If you operate multiple wikis, you can declare a shared upload path here.
546 * Uploads to the local wiki will NOT be stored here - See $wgLocalFileRepo
547 * and $wgUploadDirectory for that.
549 * The wiki will only consider the foreign repository if no file of the given name
550 * is found in the local repository (e.g. via `[[File:..]]` syntax).
553 * @see $wgLocalFileRepo
555 $wgForeignFileRepos = [];
558 * Use Wikimedia Commons as a foreign file repository.
560 * This is a shortcut for adding an entry to to $wgForeignFileRepos
561 * for https://commons.wikimedia.org, using ForeignAPIRepo with the
566 $wgUseInstantCommons = false;
569 * Shortcut for adding an entry to $wgForeignFileRepos.
571 * Uses the following variables:
573 * - directory: $wgSharedUploadDirectory.
574 * - url: $wgSharedUploadPath.
575 * - hashLevels: Based on $wgHashedSharedUploadDirectory.
576 * - thumbScriptUrl: $wgSharedThumbnailScriptPath.
577 * - transformVia404: Based on $wgGenerateThumbnailOnParse.
578 * - descBaseUrl: $wgRepositoryBaseUrl.
579 * - fetchDescription: $wgFetchCommonsDescriptions.
581 * If $wgSharedUploadDBname is set, it uses the ForeignDBRepo
582 * class, with also the following variables:
584 * - dbName: $wgSharedUploadDBname.
585 * - dbType: $wgDBtype.
586 * - dbServer: $wgDBserver.
587 * - dbUser: $wgDBuser.
588 * - dbPassword: $wgDBpassword.
589 * - dbFlags: Based on $wgDebugDumpSql.
590 * - tablePrefix: $wgSharedUploadDBprefix,
591 * - hasSharedCache: $wgCacheSharedUploads.
596 $wgUseSharedUploads = false;
599 * Shortcut for the 'directory' setting of $wgForeignFileRepos.
600 * Only used if $wgUseSharedUploads is enabled.
605 $wgSharedUploadDirectory = null;
608 * Shortcut for the 'url' setting of $wgForeignFileRepos.
609 * Only used if $wgUseSharedUploads is enabled.
614 $wgSharedUploadPath = null;
617 * Shortcut for the 'hashLevels' setting of $wgForeignFileRepos.
618 * Only used if $wgUseSharedUploads is enabled.
623 $wgHashedSharedUploadDirectory = true;
626 * Shortcut for the 'descBaseUrl' setting of $wgForeignFileRepos.
627 * Only used if $wgUseSharedUploads is enabled.
631 $wgRepositoryBaseUrl = 'https://commons.wikimedia.org/wiki/File:';
634 * Shortcut for the 'fetchDescription' setting of $wgForeignFileRepos.
635 * Only used if $wgUseSharedUploads is enabled.
640 $wgFetchCommonsDescriptions = false;
643 * Shortcut for the ForeignDBRepo 'dbName' setting in $wgForeignFileRepos.
644 * Set this to false if the uploads do not come from a wiki.
645 * Only used if $wgUseSharedUploads is enabled.
650 $wgSharedUploadDBname = false;
653 * Shortcut for the ForeignDBRepo 'tablePrefix' setting in $wgForeignFileRepos.
654 * Only used if $wgUseSharedUploads is enabled.
659 $wgSharedUploadDBprefix = '';
662 * Shortcut for the ForeignDBRepo 'hasSharedCache' setting in $wgForeignFileRepos.
663 * Only used if $wgUseSharedUploads is enabled.
668 $wgCacheSharedUploads = true;
671 * Array of foreign file repo names (set in $wgForeignFileRepos above) that
672 * are allowable upload targets. These wikis must have some method of
673 * authentication (i.e. CentralAuth), and be CORS-enabled for this wiki.
674 * The string 'local' signifies the default local file repository.
677 * $wgForeignUploadTargets = [ 'shared' ];
679 $wgForeignUploadTargets = [ 'local' ];
682 * Configuration for file uploads using the embeddable upload dialog
683 * (https://www.mediawiki.org/wiki/Upload_dialog).
685 * This applies also to foreign uploads to this wiki (the configuration is loaded by remote wikis
686 * using the action=query&meta=siteinfo API).
688 * See below for documentation of each property. None of the properties may be omitted.
691 // Fields to make available in the dialog. `true` means that this field is visible, `false` means
692 // that it is hidden. The "Name" field can't be hidden. Note that you also have to add the
693 // matching replacement to the 'filepage' format key below to make use of these.
695 'description' => true,
697 'categories' => false,
699 // Suffix of localisation messages used to describe the license under which the uploaded file will
700 // be released. The same value may be set for both 'local' and 'foreign' uploads.
701 'licensemessages' => [
702 // The 'local' messages are used for local uploads on this wiki:
703 // * upload-form-label-own-work-message-generic-local
704 // * upload-form-label-not-own-work-message-generic-local
705 // * upload-form-label-not-own-work-local-generic-local
706 'local' => 'generic-local',
707 // The 'foreign' messages are used for cross-wiki uploads from other wikis to this wiki:
708 // * upload-form-label-own-work-message-generic-foreign
709 // * upload-form-label-not-own-work-message-generic-foreign
710 // * upload-form-label-not-own-work-local-generic-foreign
711 'foreign' => 'generic-foreign',
713 // Upload comments to use for 'local' and 'foreign' uploads. This can also be set to a single
714 // string value, in which case it is used for both kinds of uploads. Available replacements:
715 // * $HOST - domain name from which a cross-wiki upload originates
716 // * $PAGENAME - wiki page name from which an upload originates
721 // Format of the file page wikitext to be generated from the fields input by the user.
723 // Wrapper for the whole page. Available replacements:
724 // * $DESCRIPTION - file description, as input by the user (only if the 'description' field is
725 // enabled), wrapped as defined below in the 'description' key
726 // * $DATE - file creation date, as input by the user (only if the 'date' field is enabled)
727 // * $SOURCE - as defined below in the 'ownwork' key, may be extended in the future
728 // * $AUTHOR - linked user name, may be extended in the future
729 // * $LICENSE - as defined below in the 'license' key, may be extended in the future
730 // * $CATEGORIES - file categories wikitext, as input by the user (only if the 'categories'
731 // field is enabled), or if no input, as defined below in the 'uncategorized' key
732 'filepage' => '$DESCRIPTION',
733 // Wrapped for file description. Available replacements:
734 // * $LANGUAGE - source wiki's content language
735 // * $TEXT - input by the user
736 'description' => '$TEXT',
739 'uncategorized' => '',
744 * File backend structure configuration.
746 * This is an array of file backend configuration arrays.
747 * Each backend configuration has the following parameters:
748 * - name : A unique name for the backend
749 * - class : The file backend class to use
750 * - wikiId : A unique string that identifies the wiki (container prefix)
751 * - lockManager : The name of a lock manager (see $wgLockManagers) [optional]
752 * - fileJournal : File journal configuration for FileJournal::__construct() [optional]
754 * See FileBackend::__construct() for more details.
755 * Additional parameters are specific to the file backend class used.
756 * These settings should be global to all wikis when possible.
758 * FileBackendMultiWrite::__construct() is augmented with a 'template' option that
759 * can be used in any of the values of the 'backends' array. Its value is the name of
760 * another backend in $wgFileBackends. When set, it pre-fills the array with all of the
761 * configuration of the named backend. Explicitly set values in the array take precedence.
763 * There are two particularly important aspects about each backend:
764 * - a) Whether it is fully qualified or wiki-relative.
765 * By default, the paths of files are relative to the current wiki,
766 * which works via prefixing them with the current wiki ID when accessed.
767 * Setting 'domainId' forces the backend to be fully qualified by prefixing
768 * all paths with the specified value instead. This can be useful if
769 * multiple wikis need to share the same data. Note that 'name' is *not*
770 * part of any prefix and thus should not be relied upon for namespacing.
771 * - b) Whether it is only defined for some wikis or is defined on all
772 * wikis in the wiki farm. Defining a backend globally is useful
773 * if multiple wikis need to share the same data.
774 * One should be aware of these aspects when configuring a backend for use with
775 * any basic feature or plugin. For example, suppose an extension stores data for
776 * different wikis in different directories and sometimes needs to access data from
777 * a foreign wiki's directory in order to render a page on given wiki. The extension
778 * would need a fully qualified backend that is defined on all wikis in the wiki farm.
780 $wgFileBackends = [];
783 * Array of configuration arrays for each lock manager.
784 * Each backend configuration has the following parameters:
785 * - name : A unique name for the lock manager
786 * - class : The lock manger class to use
788 * See LockManager::__construct() for more details.
789 * Additional parameters are specific to the lock manager class used.
790 * These settings should be global to all wikis.
792 $wgLockManagers = [];
795 * Show Exif data, on by default if available.
796 * Requires PHP's Exif extension: https://www.php.net/manual/en/ref.exif.php
798 * @note FOR WINDOWS USERS:
799 * To enable Exif functions, add the following line to the "Windows
800 * extensions" section of php.ini:
802 * extension=extensions/php_exif.dll
805 $wgShowEXIF = function_exists( 'exif_read_data' );
808 * If to automatically update the img_metadata field
809 * if the metadata field is outdated but compatible with the current version.
812 $wgUpdateCompatibleMetadata = false;
815 * Allow for upload to be copied from an URL.
816 * The timeout for copy uploads is set by $wgCopyUploadTimeout.
817 * You have to assign the user right 'upload_by_url' to a user group, to use this.
819 $wgAllowCopyUploads = false;
822 * A list of domains copy uploads can come from
826 $wgCopyUploadsDomains = [];
829 * Enable copy uploads from Special:Upload. $wgAllowCopyUploads must also be
830 * true. If $wgAllowCopyUploads is true, but this is false, you will only be
831 * able to perform copy uploads from the API or extensions (e.g. UploadWizard).
833 $wgCopyUploadsFromSpecialUpload = false;
836 * Proxy to use for copy upload requests.
839 $wgCopyUploadProxy = false;
842 * Different timeout for upload by url
843 * This could be useful since when fetching large files, you may want a
844 * timeout longer than the default $wgHTTPTimeout. False means fallback
851 $wgCopyUploadTimeout = false;
854 * Max size for uploads, in bytes. If not set to an array, applies to all
855 * uploads. If set to an array, per upload type maximums can be set, using the
856 * file and url keys. If the * key is set this value will be used as maximum
857 * for non-specified types.
861 * $wgMaxUploadSize = [
863 * 'url' => 500 * 1024,
866 * Sets the maximum for all uploads to 250 kB except for upload-by-url, which
867 * will have a maximum of 500 kB.
869 $wgMaxUploadSize = 1024 * 1024 * 100; # 100MB
872 * Minimum upload chunk size, in bytes. When using chunked upload, non-final
873 * chunks smaller than this will be rejected. May be reduced based on the
874 * 'upload_max_filesize' or 'post_max_size' PHP settings.
877 $wgMinUploadChunkSize = 1024; # 1KB
880 * Point the upload navigation link to an external URL
881 * Useful if you want to use a shared repository by default
882 * without disabling local uploads (use $wgEnableUploads = false for that).
886 * $wgUploadNavigationUrl = 'https://commons.wikimedia.org/wiki/Special:Upload';
889 $wgUploadNavigationUrl = false;
892 * Point the upload link for missing files to an external URL, as with
893 * $wgUploadNavigationUrl. The URL will get "(?|&)wpDestFile=<filename>"
894 * appended to it as appropriate.
896 $wgUploadMissingFileUrl = false;
899 * Give a path here to use thumb.php for thumbnail generation on client
900 * request, instead of generating them on render and outputting a static URL.
901 * This is necessary if some of your apache servers don't have read/write
902 * access to the thumbnail path.
906 * $wgThumbnailScriptPath = "{$wgScriptPath}/thumb.php";
909 $wgThumbnailScriptPath = false;
912 * Shortcut for the 'thumbScriptUrl' setting of $wgForeignFileRepos.
913 * Only used if $wgUseSharedUploads is enabled.
918 $wgSharedThumbnailScriptPath = false;
921 * Set this to false if you do not want MediaWiki to divide your images
922 * directory into many subdirectories, for improved performance.
924 * It's almost always good to leave this enabled. In previous versions of
925 * MediaWiki, some users set this to false to allow images to be added to the
926 * wiki by simply copying them into $wgUploadDirectory and then running
927 * maintenance/rebuildImages.php to register them in the database. This is no
928 * longer recommended, use maintenance/importImages.php instead.
930 * @note That this variable may be ignored if $wgLocalFileRepo is set.
931 * @todo Deprecate the setting and ultimately remove it from Core.
933 $wgHashedUploadDirectory = true;
936 * This is the list of preferred extensions for uploading files. Uploading files
937 * with extensions not in this list will trigger a warning.
939 * @warning If you add any OpenOffice or Microsoft Office file formats here,
940 * such as odt or doc, and untrusted users are allowed to upload files, then
941 * your wiki will be vulnerable to cross-site request forgery (CSRF).
943 $wgFileExtensions = [ 'png', 'gif', 'jpg', 'jpeg', 'webp' ];
946 * Files with these extensions will never be allowed as uploads.
947 * An array of file extensions to blacklist. You should append to this array
948 * if you want to blacklist additional files.
951 # HTML may contain cookie-stealing JavaScript and web bugs
952 'html', 'htm', 'js', 'jsb', 'mhtml', 'mht', 'xhtml', 'xht',
953 # PHP scripts may execute arbitrary code on the server
954 'php', 'phtml', 'php3', 'php4', 'php5', 'phps', 'phar',
955 # Other types that may be interpreted by some servers
956 'shtml', 'jhtml', 'pl', 'py', 'cgi',
957 # May contain harmful executables for Windows victims
958 'exe', 'scr', 'dll', 'msi', 'vbs', 'bat', 'com', 'pif', 'cmd', 'vxd', 'cpl' ];
961 * Files with these MIME types will never be allowed as uploads
962 * if $wgVerifyMimeType is enabled.
964 $wgMimeTypeBlacklist = [
965 # HTML may contain cookie-stealing JavaScript and web bugs
966 'text/html', 'text/javascript', 'text/x-javascript', 'application/x-shellscript',
967 # PHP scripts may execute arbitrary code on the server
968 'application/x-php', 'text/x-php',
969 # Other types that may be interpreted by some servers
970 'text/x-python', 'text/x-perl', 'text/x-bash', 'text/x-sh', 'text/x-csh',
971 # Client-side hazards on Internet Explorer
972 'text/scriptlet', 'application/x-msdownload',
973 # Windows metafile, client-side vulnerability on some systems
974 'application/x-msmetafile',
978 * Allow Java archive uploads.
979 * This is not recommended for public wikis since a maliciously-constructed
980 * applet running on the same domain as the wiki can steal the user's cookies.
982 $wgAllowJavaUploads = false;
985 * This is a flag to determine whether or not to check file extensions on upload.
987 * @warning Setting this to false is insecure for public wikis.
989 $wgCheckFileExtensions = true;
992 * If this is turned off, users may override the warning for files not covered
993 * by $wgFileExtensions.
995 * @warning Setting this to false is insecure for public wikis.
997 $wgStrictFileExtensions = true;
1000 * Setting this to true will disable the upload system's checks for HTML/JavaScript.
1002 * @warning THIS IS VERY DANGEROUS on a publicly editable site, so USE
1003 * $wgGroupPermissions TO RESTRICT UPLOADING to only those that you trust
1005 $wgDisableUploadScriptChecks = false;
1008 * Warn if uploaded files are larger than this (in bytes), or false to disable
1010 $wgUploadSizeWarning = false;
1013 * list of trusted media-types and MIME types.
1014 * Use the MEDIATYPE_xxx constants to represent media types.
1015 * This list is used by File::isSafeFile
1017 * Types not listed here will have a warning about unsafe content
1018 * displayed on the images description page. It would also be possible
1019 * to use this for further restrictions, like disabling direct
1020 * [[media:...]] links for non-trusted formats.
1022 $wgTrustedMediaFormats = [
1023 MEDIATYPE_BITMAP
, // all bitmap formats
1024 MEDIATYPE_AUDIO
, // all audio formats
1025 MEDIATYPE_VIDEO
, // all plain video formats
1026 "image/svg+xml", // svg (only needed if inline rendering of svg is not supported)
1027 "application/pdf", // PDF files
1028 # "application/x-shockwave-flash", //flash/shockwave movie
1032 * Plugins for media file type handling.
1033 * Each entry in the array maps a MIME type to a class name
1035 * Core media handlers are listed in MediaHandlerFactory,
1036 * and extensions should use extension.json.
1038 $wgMediaHandlers = [];
1041 * Media handler overrides for parser tests (they don't need to generate actual
1042 * thumbnails, so a mock will do)
1044 $wgParserTestMediaHandlers = [
1045 'image/jpeg' => 'MockBitmapHandler',
1046 'image/png' => 'MockBitmapHandler',
1047 'image/gif' => 'MockBitmapHandler',
1048 'image/tiff' => 'MockBitmapHandler',
1049 'image/webp' => 'MockBitmapHandler',
1050 'image/x-ms-bmp' => 'MockBitmapHandler',
1051 'image/x-bmp' => 'MockBitmapHandler',
1052 'image/x-xcf' => 'MockBitmapHandler',
1053 'image/svg+xml' => 'MockSvgHandler',
1054 'image/vnd.djvu' => 'MockDjVuHandler',
1058 * Plugins for page content model handling.
1059 * Each entry in the array maps a model id to a class name or callback
1060 * that creates an instance of the appropriate ContentHandler subclass.
1064 $wgContentHandlers = [
1066 CONTENT_MODEL_WIKITEXT
=> WikitextContentHandler
::class,
1067 // dumb version, no syntax highlighting
1068 CONTENT_MODEL_JAVASCRIPT
=> JavaScriptContentHandler
::class,
1069 // simple implementation, for use by extensions, etc.
1070 CONTENT_MODEL_JSON
=> JsonContentHandler
::class,
1071 // dumb version, no syntax highlighting
1072 CONTENT_MODEL_CSS
=> CssContentHandler
::class,
1073 // plain text, for use by extensions, etc.
1074 CONTENT_MODEL_TEXT
=> TextContentHandler
::class,
1078 * Whether to enable server-side image thumbnailing. If false, images will
1079 * always be sent to the client in full resolution, with appropriate width= and
1080 * height= attributes on the <img> tag for the client to do its own scaling.
1082 $wgUseImageResize = true;
1085 * Resizing can be done using PHP's internal image libraries or using
1086 * ImageMagick or another third-party converter, e.g. GraphicMagick.
1087 * These support more file formats than PHP, which only supports PNG,
1088 * GIF, JPG, XBM and WBMP.
1090 * Use Image Magick instead of PHP builtin functions.
1092 $wgUseImageMagick = false;
1095 * The convert command shipped with ImageMagick
1097 $wgImageMagickConvertCommand = '/usr/bin/convert';
1100 * Array of max pixel areas for interlacing per MIME type
1103 $wgMaxInterlacingAreas = [];
1106 * Sharpening parameter to ImageMagick
1108 $wgSharpenParameter = '0x0.4';
1111 * Reduction in linear dimensions below which sharpening will be enabled
1113 $wgSharpenReductionThreshold = 0.85;
1116 * Temporary directory used for ImageMagick. The directory must exist. Leave
1117 * this set to false to let ImageMagick decide for itself.
1119 $wgImageMagickTempDir = false;
1122 * Use another resizing converter, e.g. GraphicMagick
1123 * %s will be replaced with the source path, %d with the destination
1124 * %w and %h will be replaced with the width and height.
1126 * @par Example for GraphicMagick:
1128 * $wgCustomConvertCommand = "gm convert %s -resize %wx%h %d"
1131 * Leave as false to skip this.
1133 $wgCustomConvertCommand = false;
1136 * used for lossless jpeg rotation
1140 $wgJpegTran = '/usr/bin/jpegtran';
1143 * At default setting of 'yuv420', JPEG thumbnails will use 4:2:0 chroma
1144 * subsampling to reduce file size, at the cost of possible color fringing
1147 * See https://en.wikipedia.org/wiki/Chroma_subsampling
1150 * false - use scaling system's default (same as pre-1.27 behavior)
1151 * 'yuv444' - luma and chroma at same resolution
1152 * 'yuv422' - chroma at 1/2 resolution horizontally, full vertically
1153 * 'yuv420' - chroma at 1/2 resolution in both dimensions
1155 * This setting is currently supported only for the ImageMagick backend;
1156 * others may default to 4:2:0 or 4:4:4 or maintaining the source file's
1157 * sampling in the thumbnail.
1161 $wgJpegPixelFormat = 'yuv420';
1164 * When scaling a JPEG thumbnail, this is the quality we request
1165 * from the backend. It should be an int between 1 and 100,
1166 * with 100 indicating 100% quality.
1170 $wgJpegQuality = 80;
1173 * Some tests and extensions use exiv2 to manipulate the Exif metadata in some
1176 $wgExiv2Command = '/usr/bin/exiv2';
1179 * Path to exiftool binary. Used for lossless ICC profile swapping.
1183 $wgExiftool = '/usr/bin/exiftool';
1186 * Scalable Vector Graphics (SVG) may be uploaded as images.
1187 * Since SVG support is not yet standard in browsers, it is
1188 * necessary to rasterize SVGs to PNG as a fallback format.
1190 * An external program is required to perform this conversion.
1191 * If set to an array, the first item is a PHP callable and any further items
1192 * are passed as parameters after $srcPath, $dstPath, $width, $height
1194 $wgSVGConverters = [
1196 '$path/convert -background "#ffffff00" -thumbnail $widthx$height\! $input PNG:$output',
1197 'sodipodi' => '$path/sodipodi -z -w $width -f $input -e $output',
1198 'inkscape' => '$path/inkscape -z -w $width -f $input -e $output',
1199 'batik' => 'java -Djava.awt.headless=true -jar $path/batik-rasterizer.jar -w $width -d '
1201 'rsvg' => '$path/rsvg-convert -w $width -h $height -o $output $input',
1202 'imgserv' => '$path/imgserv-wrapper -i svg -o png -w$width $input $output',
1203 'ImagickExt' => [ 'SvgHandler::rasterizeImagickExt' ],
1207 * Pick a converter defined in $wgSVGConverters
1209 $wgSVGConverter = 'ImageMagick';
1212 * If not in the executable PATH, specify the SVG converter path.
1214 $wgSVGConverterPath = '';
1217 * Don't scale a SVG larger than this
1219 $wgSVGMaxSize = 5120;
1222 * Don't read SVG metadata beyond this point.
1223 * Default is 1024*256 bytes
1225 $wgSVGMetadataCutoff = 262144;
1228 * Obsolete, no longer used.
1229 * SVG file uploads now always allow <title> elements.
1233 $wgAllowTitlesInSVG = true;
1236 * Whether thumbnails should be generated in target language (usually, same as
1237 * page language), if available.
1238 * Currently, applies only to SVG images that use the systemLanguage attribute
1239 * to specify text language.
1243 $wgMediaInTargetLanguage = true;
1246 * The maximum number of pixels a source image can have if it is to be scaled
1247 * down by a scaler that requires the full source image to be decompressed
1248 * and stored in decompressed form, before the thumbnail is generated.
1250 * This provides a limit on memory usage for the decompression side of the
1251 * image scaler. The limit is used when scaling PNGs with any of the
1252 * built-in image scalers, such as ImageMagick or GD. It is ignored for
1253 * JPEGs with ImageMagick, and when using the VipsScaler extension.
1255 * The default is 50 MB if decompressed to RGBA form, which corresponds to
1256 * 12.5 million pixels or 3500x3500.
1258 $wgMaxImageArea = 1.25e7
;
1261 * Force thumbnailing of animated GIFs above this size to a single
1262 * frame instead of an animated thumbnail. As of MW 1.17 this limit
1263 * is checked against the total size of all frames in the animation.
1264 * It probably makes sense to keep this equal to $wgMaxImageArea.
1266 $wgMaxAnimatedGifArea = 1.25e7
;
1269 * Browsers don't support TIFF inline generally...
1270 * For inline display, we need to convert to PNG or JPEG.
1271 * Note scaling should work with ImageMagick, but may not with GD scaling.
1275 * // PNG is lossless, but inefficient for photos
1276 * $wgTiffThumbnailType = [ 'png', 'image/png' ];
1277 * // JPEG is good for photos, but has no transparency support. Bad for diagrams.
1278 * $wgTiffThumbnailType = [ 'jpg', 'image/jpeg' ];
1281 $wgTiffThumbnailType = [];
1284 * If rendered thumbnail files are older than this timestamp, they
1285 * will be rerendered on demand as if the file didn't already exist.
1286 * Update if there is some need to force thumbs and SVG rasterizations
1287 * to rerender, such as fixes to rendering bugs.
1289 $wgThumbnailEpoch = '20030516000000';
1292 * Certain operations are avoided if there were too many recent failures,
1293 * for example, thumbnail generation. Bump this value to invalidate all
1294 * memory of failed operations and thus allow further attempts to resume.
1295 * This is useful when a cause for the failures has been found and fixed.
1297 $wgAttemptFailureEpoch = 1;
1300 * If set, inline scaled images will still produce "<img>" tags ready for
1301 * output instead of showing an error message.
1303 * This may be useful if errors are transitory, especially if the site
1304 * is configured to automatically render thumbnails on request.
1306 * On the other hand, it may obscure error conditions from debugging.
1307 * Enable the debug log or the 'thumbnail' log group to make sure errors
1308 * are logged to a file for review.
1310 $wgIgnoreImageErrors = false;
1313 * Allow thumbnail rendering on page view. If this is false, a valid
1314 * thumbnail URL is still output, but no file will be created at
1315 * the target location. This may save some time if you have a
1316 * thumb.php or 404 handler set up which is faster than the regular
1319 $wgGenerateThumbnailOnParse = true;
1322 * Show thumbnails for old images on the image description page
1324 $wgShowArchiveThumbnails = true;
1327 * If set to true, images that contain certain the exif orientation tag will
1328 * be rotated accordingly. If set to null, try to auto-detect whether a scaler
1329 * is available that can rotate.
1331 $wgEnableAutoRotation = null;
1334 * Internal name of virus scanner. This serves as a key to the
1335 * $wgAntivirusSetup array. Set this to NULL to disable virus scanning. If not
1336 * null, every file uploaded will be scanned for viruses.
1338 $wgAntivirus = null;
1341 * Configuration for different virus scanners. This an associative array of
1342 * associative arrays. It contains one setup array per known scanner type.
1343 * The entry is selected by $wgAntivirus, i.e.
1344 * valid values for $wgAntivirus are the keys defined in this array.
1346 * The configuration array for each scanner contains the following keys:
1347 * "command", "codemap", "messagepattern":
1349 * "command" is the full command to call the virus scanner - %f will be
1350 * replaced with the name of the file to scan. If not present, the filename
1351 * will be appended to the command. Note that this must be overwritten if the
1352 * scanner is not in the system path; in that case, please set
1353 * $wgAntivirusSetup[$wgAntivirus]['command'] to the desired command with full
1356 * "codemap" is a mapping of exit code to return codes of the detectVirus
1357 * function in SpecialUpload.
1358 * - An exit code mapped to AV_SCAN_FAILED causes the function to consider
1359 * the scan to be failed. This will pass the file if $wgAntivirusRequired
1361 * - An exit code mapped to AV_SCAN_ABORTED causes the function to consider
1362 * the file to have an unsupported format, which is probably immune to
1363 * viruses. This causes the file to pass.
1364 * - An exit code mapped to AV_NO_VIRUS will cause the file to pass, meaning
1365 * no virus was found.
1366 * - All other codes (like AV_VIRUS_FOUND) will cause the function to report
1368 * - You may use "*" as a key in the array to catch all exit codes not mapped otherwise.
1370 * "messagepattern" is a perl regular expression to extract the meaningful part of the scanners
1371 * output. The relevant part should be matched as group one (\1).
1372 * If not defined or the pattern does not match, the full message is shown to the user.
1374 $wgAntivirusSetup = [
1378 'command' => 'clamscan --no-summary ',
1380 "0" => AV_NO_VIRUS
, # no virus
1381 "1" => AV_VIRUS_FOUND
, # virus found
1382 "52" => AV_SCAN_ABORTED
, # unsupported file format (probably immune)
1383 "*" => AV_SCAN_FAILED
, # else scan failed
1385 'messagepattern' => '/.*?:(.*)/sim',
1390 * Determines if a failed virus scan (AV_SCAN_FAILED) will cause the file to be rejected.
1392 $wgAntivirusRequired = true;
1395 * Determines if the MIME type of uploaded files should be checked
1397 $wgVerifyMimeType = true;
1400 * Determines whether extra checks for IE type detection should be applied.
1401 * This is a conservative check for exactly what IE 6 or so checked for,
1402 * and shouldn't trigger on for instance JPEG files containing links in EXIF
1407 $wgVerifyMimeTypeIE = true;
1410 * Sets the MIME type definition file to use by includes/libs/mime/MimeAnalyzer.php.
1411 * Set to null, to use built-in defaults only.
1412 * example: $wgMimeTypeFile = '/etc/mime.types';
1414 $wgMimeTypeFile = 'includes/mime.types';
1417 * Sets the MIME type info file to use by includes/libs/mime/MimeAnalyzer.php.
1418 * Set to null, to use built-in defaults only.
1420 $wgMimeInfoFile = 'includes/mime.info';
1423 * Sets an external MIME detector program. The command must print only
1424 * the MIME type to standard output.
1425 * The name of the file to process will be appended to the command given here.
1426 * If not set or NULL, PHP's mime_content_type function will be used.
1430 * #$wgMimeDetectorCommand = "file -bi"; # use external MIME detector (Linux)
1433 $wgMimeDetectorCommand = null;
1436 * Switch for trivial MIME detection. Used by thumb.php to disable all fancy
1437 * things, because only a few types of images are needed and file extensions
1440 $wgTrivialMimeDetection = false;
1443 * Additional XML types we can allow via MIME-detection.
1444 * array = [ 'rootElement' => 'associatedMimeType' ]
1447 'http://www.w3.org/2000/svg:svg' => 'image/svg+xml',
1448 'svg' => 'image/svg+xml',
1449 'http://www.lysator.liu.se/~alla/dia/:diagram' => 'application/x-dia-diagram',
1450 'http://www.w3.org/1999/xhtml:html' => 'text/html', // application/xhtml+xml?
1451 'html' => 'text/html', // application/xhtml+xml?
1455 * Limit images on image description pages to a user-selectable limit. In order
1456 * to reduce disk usage, limits can only be selected from a list.
1457 * The user preference is saved as an array offset in the database, by default
1458 * the offset is set with $wgDefaultUserOptions['imagesize']. Make sure you
1459 * change it if you alter the array (see T10858).
1460 * This is the list of settings the user can choose from:
1471 * Adjust thumbnails on image pages according to a user setting. In order to
1472 * reduce disk usage, the values can only be selected from a list. This is the
1473 * list of settings the user can choose from:
1485 * When defined, is an array of image widths used as buckets for thumbnail generation.
1486 * The goal is to save resources by generating thumbnails based on reference buckets instead of
1487 * always using the original. This will incur a speed gain but cause a quality loss.
1489 * The buckets generation is chained, with each bucket generated based on the above bucket
1490 * when possible. File handlers have to opt into using that feature. For now only BitmapHandler
1493 $wgThumbnailBuckets = null;
1496 * When using thumbnail buckets as defined above, this sets the minimum distance to the bucket
1497 * above the requested size. The distance represents how many extra pixels of width the bucket
1498 * needs in order to be used as the reference for a given thumbnail. For example, with the
1499 * following buckets:
1501 * $wgThumbnailBuckets = [ 128, 256, 512 ];
1503 * and a distance of 50:
1505 * $wgThumbnailMinimumBucketDistance = 50;
1507 * If we want to render a thumbnail of width 220px, the 512px bucket will be used,
1508 * because 220 + 50 = 270 and the closest bucket bigger than 270px is 512.
1510 $wgThumbnailMinimumBucketDistance = 50;
1513 * When defined, is an array of thumbnail widths to be rendered at upload time. The idea is to
1514 * prerender common thumbnail sizes, in order to avoid the necessity to render them on demand, which
1515 * has a performance impact for the first client to view a certain size.
1517 * This obviously means that more disk space is needed per upload upfront.
1522 $wgUploadThumbnailRenderMap = [];
1525 * The method through which the thumbnails will be prerendered for the entries in
1526 * $wgUploadThumbnailRenderMap
1528 * The method can be either "http" or "jobqueue". The former uses an http request to hit the
1530 * This method only works if thumbnails are configured to be rendered by a 404 handler. The latter
1531 * option uses the job queue to render the thumbnail.
1535 $wgUploadThumbnailRenderMethod = 'jobqueue';
1538 * When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom Host HTTP header.
1542 $wgUploadThumbnailRenderHttpCustomHost = false;
1545 * When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom domain to send the
1550 $wgUploadThumbnailRenderHttpCustomDomain = false;
1553 * When this variable is true and JPGs use the sRGB ICC profile, swaps it for the more lightweight
1554 * (and free) TinyRGB profile when generating thumbnails.
1558 $wgUseTinyRGBForJPGThumbnails = false;
1561 * Parameters for the "<gallery>" tag.
1563 * - imagesPerRow: Default number of images per-row in the gallery. 0 -> Adapt to screensize
1564 * - imageWidth: Width of the cells containing images in galleries (in "px")
1565 * - imageHeight: Height of the cells containing images in galleries (in "px")
1566 * - captionLength: Length to truncate filename to in caption when using "showfilename".
1567 * A value of 'true' will truncate the filename to one line using CSS
1568 * and will be the behaviour after deprecation.
1569 * @deprecated since 1.28
1570 * - showBytes: Show the filesize in bytes in categories
1571 * - showDimensions: Show the dimensions (width x height) in categories
1572 * - mode: Gallery mode
1574 $wgGalleryOptions = [];
1577 * Adjust width of upright images when parameter 'upright' is used
1578 * This allows a nicer look for upright images without the need to fix the width
1579 * by hardcoded px in wiki sourcecode.
1581 $wgThumbUpright = 0.75;
1584 * Default value for chmoding of new directories.
1586 $wgDirectoryMode = 0777;
1589 * Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities.
1591 * This means a 320x240 use of an image on the wiki will also generate 480x360 and 640x480
1592 * thumbnails, output via the srcset attribute.
1594 $wgResponsiveImages = true;
1597 * @name DJVU settings
1602 * Path of the djvudump executable
1603 * Enable this and $wgDjvuRenderer to enable djvu rendering
1604 * example: $wgDjvuDump = 'djvudump';
1609 * Path of the ddjvu DJVU renderer
1610 * Enable this and $wgDjvuDump to enable djvu rendering
1611 * example: $wgDjvuRenderer = 'ddjvu';
1613 $wgDjvuRenderer = null;
1616 * Path of the djvutxt DJVU text extraction utility
1617 * Enable this and $wgDjvuDump to enable text layer extraction from djvu files
1618 * example: $wgDjvuTxt = 'djvutxt';
1623 * Path of the djvutoxml executable
1624 * This works like djvudump except much, much slower as of version 3.5.
1626 * For now we recommend you use djvudump instead. The djvuxml output is
1627 * probably more stable, so we'll switch back to it as soon as they fix
1628 * the efficiency problem.
1629 * https://sourceforge.net/tracker/index.php?func=detail&aid=1704049&group_id=32953&atid=406583
1633 * $wgDjvuToXML = 'djvutoxml';
1636 $wgDjvuToXML = null;
1639 * Shell command for the DJVU post processor
1640 * Default: pnmtojpeg, since ddjvu generates ppm output
1641 * Set this to false to output the ppm file directly.
1643 $wgDjvuPostProcessor = 'pnmtojpeg';
1646 * File extension for the DJVU post processor output
1648 $wgDjvuOutputExtension = 'jpg';
1650 /** @} */ # end of DJvu }
1652 /** @} */ # end of file uploads }
1654 /************************************************************************//**
1655 * @name Email settings
1660 * Site admin email address.
1662 * Defaults to "wikiadmin@$wgServerName" (in Setup.php).
1664 $wgEmergencyContact = false;
1667 * Sender email address for e-mail notifications.
1669 * The address we use as sender when a user requests a password reminder,
1670 * as well as other e-mail notifications.
1672 * Defaults to "apache@$wgServerName" (in Setup.php).
1674 $wgPasswordSender = false;
1677 * Reply-To address for e-mail notifications.
1679 * Defaults to $wgPasswordSender (in Setup.php).
1681 $wgNoReplyAddress = false;
1684 * Set to true to enable the e-mail basic features:
1685 * Password reminders, etc. If sending e-mail on your
1686 * server doesn't work, you might want to disable this.
1688 $wgEnableEmail = true;
1691 * Set to true to enable user-to-user e-mail.
1692 * This can potentially be abused, as it's hard to track.
1694 $wgEnableUserEmail = true;
1697 * Set to true to enable the Special Mute page. This allows users
1698 * to mute unwanted communications from other users, and is linked
1699 * to from emails originating from Special:Email.
1704 $wgEnableSpecialMute = false;
1707 * Set to true to enable user-to-user e-mail blacklist.
1711 $wgEnableUserEmailBlacklist = false;
1714 * If true put the sending user's email in a Reply-To header
1715 * instead of From (false). ($wgPasswordSender will be used as From.)
1717 * Some mailers (eg SMTP) set the SMTP envelope sender to the From value,
1718 * which can cause problems with SPF validation and leak recipient addresses
1719 * when bounces are sent to the sender. In addition, DMARC restrictions
1720 * can cause emails to fail to be received when false.
1722 $wgUserEmailUseReplyTo = true;
1725 * Minimum time, in hours, which must elapse between password reminder
1726 * emails for a given account. This is to prevent abuse by mail flooding.
1728 $wgPasswordReminderResendTime = 24;
1731 * The time, in seconds, when an emailed temporary password expires.
1733 $wgNewPasswordExpiry = 3600 * 24 * 7;
1736 * The time, in seconds, when an email confirmation email expires
1738 $wgUserEmailConfirmationTokenExpiry = 7 * 24 * 60 * 60;
1741 * The number of days that a user's password is good for. After this number of days, the
1742 * user will be asked to reset their password. Set to false to disable password expiration.
1744 $wgPasswordExpirationDays = false;
1747 * If a user's password is expired, the number of seconds when they can still login,
1748 * and cancel their password change, but are sent to the password change form on each login.
1750 $wgPasswordExpireGrace = 3600 * 24 * 7; // 7 days
1755 * For using a direct (authenticated) SMTP server connection.
1756 * Default to false or fill an array :
1760 * 'host' => 'SMTP domain',
1761 * 'IDHost' => 'domain for MessageID',
1763 * 'auth' => [true|false],
1764 * 'username' => [SMTP username],
1765 * 'password' => [SMTP password],
1772 * Additional email parameters, will be passed as the last argument to mail() call.
1774 $wgAdditionalMailParams = null;
1777 * For parts of the system that have been updated to provide HTML email content, send
1778 * both text and HTML parts as the body of the email
1780 $wgAllowHTMLEmail = false;
1783 * Allow sending of e-mail notifications with the editor's address as sender.
1785 * This setting depends on $wgEnotifRevealEditorAddress also being enabled.
1786 * If both are enabled, notifications for actions from users that have opted-in,
1787 * will be sent to other users with their address as "From" instead of "Reply-To".
1789 * If disabled, or not opted-in, notifications come from $wgPasswordSender.
1793 $wgEnotifFromEditor = false;
1795 // TODO move UPO to preferences probably ?
1796 # If set to true, users get a corresponding option in their preferences and can choose to
1797 # enable or disable at their discretion
1798 # If set to false, the corresponding input form on the user preference page is suppressed
1799 # It call this to be a "user-preferences-option (UPO)"
1802 * Require email authentication before sending mail to an email address.
1803 * This is highly recommended. It prevents MediaWiki from being used as an open
1806 $wgEmailAuthentication = true;
1809 * Allow users to enable email notification ("enotif") on watchlist changes.
1811 $wgEnotifWatchlist = false;
1814 * Allow users to enable email notification ("enotif") when someone edits their
1817 * The owner of the user talk page must also have the 'enotifusertalkpages' user
1818 * preference set to true.
1820 $wgEnotifUserTalk = false;
1823 * Allow sending of e-mail notifications with the editor's address in "Reply-To".
1825 * Note, enabling this only actually uses it in notification e-mails if the user
1826 * opted-in to this feature. This feature flag also controls visibility of the
1827 * 'enotifrevealaddr' preference, which, if users opt into, will make e-mail
1828 * notifications about their actions use their address as "Reply-To".
1830 * To set the address as "From" instead of "Reply-To", also enable $wgEnotifFromEditor.
1832 * If disabled, or not opted-in, notifications come from $wgPasswordSender.
1836 $wgEnotifRevealEditorAddress = false;
1839 * Potentially send notification mails on minor edits to pages. This is enabled
1840 * by default. If this is false, users will never be notified on minor edits.
1842 * If it is true, editors with the 'nominornewtalk' right (typically bots) will still not
1843 * trigger notifications for minor edits they make (to any page, not just user talk).
1845 * Finally, if the watcher/recipient has the 'enotifminoredits' user preference set to
1846 * false, they will not receive notifications for minor edits.
1848 * User talk notifications are also affected by $wgEnotifMinorEdits, the above settings,
1849 * $wgEnotifUserTalk, and the preference described there.
1851 $wgEnotifMinorEdits = true;
1854 * Send a generic mail instead of a personalised mail for each user. This
1855 * always uses UTC as the time zone, and doesn't include the username.
1857 * For pages with many users watching, this can significantly reduce mail load.
1858 * Has no effect when using sendmail rather than SMTP.
1860 $wgEnotifImpersonal = false;
1863 * Maximum number of users to mail at once when using impersonal mail. Should
1864 * match the limit on your mail server.
1866 $wgEnotifMaxRecips = 500;
1869 * Use real name instead of username in e-mail "from" field.
1871 $wgEnotifUseRealName = false;
1874 * Array of usernames who will be sent a notification email for every change
1875 * which occurs on a wiki. Users will not be notified of their own changes.
1877 $wgUsersNotifiedOnAllChanges = [];
1879 /** @} */ # end of email settings
1881 /************************************************************************//**
1882 * @name Database settings
1887 * Current wiki database name
1889 * Should be alphanumeric, without spaces nor hyphens.
1890 * This is used to determine the current/local wiki ID (WikiMap::getCurrentWikiDbDomain).
1892 * This should still be set even if $wgLBFactoryConf is configured.
1894 $wgDBname = 'my_wiki';
1897 * Current wiki database schema name
1899 * Should be alphanumeric, without spaces nor hyphens.
1900 * This is used to determine the current/local wiki ID (WikiMap::getCurrentWikiDbDomain).
1902 * This should still be set even if $wgLBFactoryConf is configured.
1904 $wgDBmwschema = null;
1907 * Current wiki database table name prefix
1909 * Should be alphanumeric, without spaces nor hyphens, preferably ending in an underscore.
1910 * This is used to determine the current/local wiki ID (WikiMap::getCurrentWikiDbDomain).
1912 * This should still be set even if $wgLBFactoryConf is configured.
1917 * Database host name or IP address
1919 $wgDBserver = 'localhost';
1922 * Database port number (for PostgreSQL and Microsoft SQL Server).
1929 $wgDBuser = 'wikiuser';
1932 * Database user's password
1939 $wgDBtype = 'mysql';
1942 * Whether to use SSL in DB connection.
1944 * This setting is only used if $wgLBFactoryConf['class'] is set to
1945 * '\Wikimedia\Rdbms\LBFactorySimple' and $wgDBservers is an empty array; otherwise
1946 * the DBO_SSL flag must be set in the 'flags' option of the database
1947 * connection to achieve the same functionality.
1952 * Whether to use compression in DB connection.
1954 * This setting is only used $wgLBFactoryConf['class'] is set to
1955 * '\Wikimedia\Rdbms\LBFactorySimple' and $wgDBservers is an empty array; otherwise
1956 * the DBO_COMPRESS flag must be set in the 'flags' option of the database
1957 * connection to achieve the same functionality.
1959 $wgDBcompress = false;
1962 * Separate username for maintenance tasks. Leave as null to use the default.
1964 $wgDBadminuser = null;
1967 * Separate password for maintenance tasks. Leave as null to use the default.
1969 $wgDBadminpassword = null;
1973 * Leave as null to select the default search engine for the
1974 * selected database type (eg SearchMySQL), or set to a class
1975 * name to override to a custom search engine.
1977 $wgSearchType = null;
1980 * Alternative search types
1981 * Sometimes you want to support multiple search engines for testing. This
1982 * allows users to select their search engine of choice via url parameters
1983 * to Special:Search and the action=search API. If using this, there's no
1984 * need to add $wgSearchType to it, that is handled automatically.
1986 $wgSearchTypeAlternatives = null;
1989 * MySQL table options to use during installation or update
1991 $wgDBTableOptions = 'ENGINE=InnoDB, DEFAULT CHARSET=binary';
1994 * SQL Mode - default is turning off all modes, including strict, if set.
1995 * null can be used to skip the setting for performance reasons and assume
1996 * DBA has done his best job.
1997 * String override can be used for some additional fun :-)
2002 * Default group to use when getting database connections.
2003 * Will be used as default query group in ILoadBalancer::getConnection.
2006 $wgDBDefaultGroup = null;
2009 * To override default SQLite data directory ($docroot/../data)
2011 $wgSQLiteDataDir = '';
2014 * Shared database for multiple wikis. Commonly used for storing a user table
2015 * for single sign-on. The server for this database must be the same as for the
2018 * For backwards compatibility the shared prefix is set to the same as the local
2019 * prefix, and the user table is listed in the default list of shared tables.
2020 * The user_properties table is also added so that users will continue to have their
2021 * preferences shared (preferences were stored in the user table prior to 1.16)
2023 * $wgSharedTables may be customized with a list of tables to share in the shared
2024 * database. However it is advised to limit what tables you do share as many of
2025 * MediaWiki's tables may have side effects if you try to share them.
2027 * $wgSharedPrefix is the table prefix for the shared database. It defaults to
2030 * $wgSharedSchema is the table schema for the shared database. It defaults to
2033 * @deprecated since 1.21 In new code, use the $wiki parameter to LBFactory::getMainLB() to
2034 * access remote databases. Using LBFactory::getMainLB() allows the shared database to
2035 * reside on separate servers to the wiki's own database, with suitable
2036 * configuration of $wgLBFactoryConf.
2043 $wgSharedPrefix = false;
2048 $wgSharedTables = [ 'user', 'user_properties' ];
2054 $wgSharedSchema = false;
2057 * Database load balancer
2058 * This is a two-dimensional array, an array of server info structures
2061 * - dbname: Default database name
2063 * - password: DB password
2065 * - driver: DB driver (when there are multiple drivers)
2067 * - load: Ratio of DB_REPLICA load, must be >=0, the sum of all loads must be >0.
2068 * If this is zero for any given server, no normal query traffic will be
2069 * sent to it. It will be excluded from lag checks in maintenance scripts.
2070 * The only way it can receive traffic is if groupLoads is used.
2072 * - groupLoads: (optional) Array of load ratios, the key is the query group name. A query
2073 * may belong to several groups, the most specific group defined here is used.
2075 * - flags: (optional) Bit field of properties:
2076 * - DBO_DEFAULT: Transactionalize web requests and use autocommit otherwise
2077 * - DBO_DEBUG: Equivalent of $wgDebugDumpSql
2078 * - DBO_SSL: Use TLS connection encryption if available
2079 * - DBO_COMPRESS: Use protocol compression with database connections
2080 * - DBO_PERSISTENT: Enables persistent database connections
2082 * - max lag: (optional) Maximum replication lag before a replica DB goes out of rotation
2083 * - is static: (optional) Set to true if the dataset is static and no replication is used.
2084 * - cliMode: (optional) Connection handles will not assume that requests are short-lived
2085 * nor that INSERT..SELECT can be rewritten into a buffered SELECT and INSERT.
2086 * This is what DBO_DEFAULT uses to determine when a web request is present.
2087 * [Default: uses value of $wgCommandLineMode]
2089 * These and any other user-defined properties will be assigned to the mLBInfo member
2090 * variable of the Database object.
2092 * Leave at false to use the single-server variables above. If you set this
2093 * variable, the single-server variables will generally be ignored (except
2094 * perhaps in some command-line scripts).
2096 * The first server listed in this array (with key 0) will be the master. The
2097 * rest of the servers will be replica DBs. To prevent writes to your replica DBs due to
2098 * accidental misconfiguration or MediaWiki bugs, set read_only=1 on all your
2099 * replica DBs in my.cnf. You can set read_only mode at runtime using:
2102 * SET @@read_only=1;
2105 * Since the effect of writing to a replica DB is so damaging and difficult to clean
2106 * up, we at Wikimedia set read_only=1 in my.cnf on all our DB servers, even
2107 * our masters, and then set read_only=0 on masters at runtime.
2109 $wgDBservers = false;
2112 * Load balancer factory configuration
2113 * To set up a multi-master wiki farm, set the class here to something that
2114 * can return a LoadBalancer with an appropriate master on a call to getMainLB().
2115 * The class identified here is responsible for reading $wgDBservers,
2116 * $wgDBserver, etc., so overriding it may cause those globals to be ignored.
2118 * The LBFactoryMulti class is provided for this purpose, please see
2119 * includes/db/LBFactoryMulti.php for configuration information.
2121 $wgLBFactoryConf = [ 'class' => \Wikimedia\Rdbms\LBFactorySimple
::class ];
2124 * After a state-changing request is done by a client, this determines
2125 * how many seconds that client should keep using the master datacenter.
2126 * This avoids unexpected stale or 404 responses due to replication lag.
2129 $wgDataCenterUpdateStickTTL = 10;
2132 * File to log database errors to
2134 $wgDBerrorLog = false;
2137 * Timezone to use in the error log.
2138 * Defaults to the wiki timezone ($wgLocaltimezone).
2140 * A list of usable timezones can found at:
2141 * https://www.php.net/manual/en/timezones.php
2145 * $wgDBerrorLogTZ = 'UTC';
2146 * $wgDBerrorLogTZ = 'GMT';
2147 * $wgDBerrorLogTZ = 'PST8PDT';
2148 * $wgDBerrorLogTZ = 'Europe/Sweden';
2149 * $wgDBerrorLogTZ = 'CET';
2154 $wgDBerrorLogTZ = false;
2157 * Other wikis on this site, can be administered from a single developer account.
2159 * @var string[] List of wiki DB domain IDs; the format of each ID consist of 1-3 hyphen
2160 * delimited alphanumeric components (each with no hyphens nor spaces) of any of the forms:
2161 * - "<DB NAME>-<DB SCHEMA>-<TABLE PREFIX>"
2162 * - "<DB NAME>-<TABLE PREFIX>"
2164 * If hyphens appear in any of the components, then the domain ID parsing may not work
2165 * in all cases and site functionality might be affected. If the schema ($wgDBmwschema)
2166 * is left to the default "mediawiki" for all wikis, then the schema should be omitted
2169 $wgLocalDatabases = [];
2172 * If lag is higher than $wgSlaveLagWarning, show a warning in some special
2173 * pages (like watchlist). If the lag is higher than $wgSlaveLagCritical,
2174 * show a more obvious warning.
2176 $wgSlaveLagWarning = 10;
2179 * @see $wgSlaveLagWarning
2181 $wgSlaveLagCritical = 30;
2184 * Use Windows Authentication instead of $wgDBuser / $wgDBpassword for MS SQL Server
2186 $wgDBWindowsAuthentication = false;
2188 /** @} */ # End of DB settings }
2190 /************************************************************************//**
2191 * @name Text storage
2196 * We can also compress text stored in the 'text' table. If this is set on, new
2197 * revisions will be compressed on page save if zlib support is available. Any
2198 * compressed revisions will be decompressed on load regardless of this setting,
2199 * but will not be readable at all* if zlib support is not available.
2201 $wgCompressRevisions = false;
2204 * External stores allow including content
2205 * from non database sources following URL links.
2207 * Short names of ExternalStore classes may be specified in an array here:
2209 * $wgExternalStores = [ "http","file","custom" ]...
2212 * CAUTION: Access to database might lead to code execution
2214 $wgExternalStores = [];
2217 * An array of external MySQL servers.
2220 * Create a cluster named 'cluster1' containing three servers:
2222 * $wgExternalServers = [
2223 * 'cluster1' => <array in the same format as $wgDBservers>
2227 * Used by \Wikimedia\Rdbms\LBFactorySimple, may be ignored if $wgLBFactoryConf is set to
2230 $wgExternalServers = [];
2233 * The place to put new revisions, false to put them in the local text table.
2234 * Part of a URL, e.g. DB://cluster1
2236 * Can be an array instead of a single string, to enable data distribution. Keys
2237 * must be consecutive integers, starting at zero.
2241 * $wgDefaultExternalStore = [ 'DB://cluster1', 'DB://cluster2' ];
2246 $wgDefaultExternalStore = false;
2249 * Revision text may be cached in $wgMemc to reduce load on external storage
2250 * servers and object extraction overhead for frequently-loaded revisions.
2252 * Set to 0 to disable, or number of seconds before cache expiry.
2254 $wgRevisionCacheExpiry = 86400 * 7;
2256 /** @} */ # end text storage }
2258 /************************************************************************//**
2259 * @name Performance hacks and limits
2264 * Disable database-intensive features
2266 $wgMiserMode = false;
2269 * Disable all query pages if miser mode is on, not just some
2271 $wgDisableQueryPages = false;
2274 * Number of rows to cache in 'querycache' table when miser mode is on
2276 $wgQueryCacheLimit = 1000;
2279 * Number of links to a page required before it is deemed "wanted"
2281 $wgWantedPagesThreshold = 1;
2284 * Enable slow parser functions
2286 $wgAllowSlowParserFunctions = false;
2289 * Allow schema updates
2291 $wgAllowSchemaUpdates = true;
2294 * Maximum article size in kilobytes
2296 $wgMaxArticleSize = 2048;
2299 * The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to
2300 * raise PHP's memory limit if it's below this amount.
2302 $wgMemoryLimit = "50M";
2305 * The minimum amount of time that MediaWiki needs for "slow" write request,
2306 * particularly ones with multiple non-atomic writes that *should* be as
2307 * transactional as possible; MediaWiki will call set_time_limit() if needed.
2310 $wgTransactionalTimeLimit = 120;
2312 /** @} */ # end performance hacks }
2314 /************************************************************************//**
2315 * @name Cache settings
2320 * Directory for caching data in the local filesystem. Should not be accessible
2323 * Note: if multiple wikis share the same localisation cache directory, they
2324 * must all have the same set of extensions. You can set a directory just for
2325 * the localisation cache using $wgLocalisationCacheConf['storeDirectory'].
2327 $wgCacheDirectory = false;
2330 * Main cache type. This should be a cache with fast access, but it may have
2331 * limited space. By default, it is disabled, since the stock database cache
2332 * is not fast enough to make it worthwhile.
2336 * - CACHE_ANYTHING: Use anything, as long as it works
2337 * - CACHE_NONE: Do not cache
2338 * - CACHE_DB: Store cache objects in the DB
2339 * - CACHE_MEMCACHED: MemCached, must specify servers in $wgMemCachedServers
2340 * - CACHE_ACCEL: APC, APCU or WinCache
2341 * - (other): A string may be used which identifies a cache
2342 * configuration in $wgObjectCaches.
2344 * @see $wgMessageCacheType, $wgParserCacheType
2346 $wgMainCacheType = CACHE_NONE
;
2349 * The cache type for storing the contents of the MediaWiki namespace. This
2350 * cache is used for a small amount of data which is expensive to regenerate.
2352 * For available types see $wgMainCacheType.
2354 $wgMessageCacheType = CACHE_ANYTHING
;
2357 * The cache type for storing article HTML. This is used to store data which
2358 * is expensive to regenerate, and benefits from having plenty of storage space.
2360 * For available types see $wgMainCacheType.
2362 $wgParserCacheType = CACHE_ANYTHING
;
2365 * The cache type for storing session data.
2367 * For available types see $wgMainCacheType.
2369 $wgSessionCacheType = CACHE_ANYTHING
;
2372 * The cache type for storing language conversion tables,
2373 * which are used when parsing certain text and interface messages.
2375 * For available types see $wgMainCacheType.
2379 $wgLanguageConverterCacheType = CACHE_ANYTHING
;
2382 * Advanced object cache configuration.
2384 * Use this to define the class names and constructor parameters which are used
2385 * for the various cache types. Custom cache types may be defined here and
2386 * referenced from $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType,
2387 * or $wgLanguageConverterCacheType.
2389 * The format is an associative array where the key is a cache identifier, and
2390 * the value is an associative array of parameters. The "class" parameter is the
2391 * class name which will be used. Alternatively, a "factory" parameter may be
2392 * given, giving a callable function which will generate a suitable cache object.
2395 CACHE_NONE
=> [ 'class' => EmptyBagOStuff
::class, 'reportDupes' => false ],
2396 CACHE_DB
=> [ 'class' => SqlBagOStuff
::class, 'loggroup' => 'SQLBagOStuff' ],
2398 CACHE_ANYTHING
=> [ 'factory' => 'ObjectCache::newAnything' ],
2399 CACHE_ACCEL
=> [ 'factory' => 'ObjectCache::getLocalServerInstance' ],
2400 CACHE_MEMCACHED
=> [ 'class' => MemcachedPhpBagOStuff
::class, 'loggroup' => 'memcached' ],
2402 'db-replicated' => [
2403 'class' => ReplicatedBagOStuff
::class,
2405 'class' => SqlBagOStuff
::class,
2406 'args' => [ [ 'replicaOnly' => true ] ]
2409 'class' => SqlBagOStuff
::class,
2410 'args' => [ [ 'replicaOnly' => false ] ]
2412 'loggroup' => 'SQLBagOStuff',
2413 'reportDupes' => false
2416 'apc' => [ 'class' => APCBagOStuff
::class, 'reportDupes' => false ],
2417 'apcu' => [ 'class' => APCUBagOStuff
::class, 'reportDupes' => false ],
2418 'wincache' => [ 'class' => WinCacheBagOStuff
::class, 'reportDupes' => false ],
2419 'memcached-php' => [ 'class' => MemcachedPhpBagOStuff
::class, 'loggroup' => 'memcached' ],
2420 'memcached-pecl' => [ 'class' => MemcachedPeclBagOStuff
::class, 'loggroup' => 'memcached' ],
2421 'hash' => [ 'class' => HashBagOStuff
::class, 'reportDupes' => false ],
2425 * Main Wide-Area-Network cache type. This should be a cache with fast access,
2426 * but it may have limited space. By default, it is disabled, since the basic stock
2427 * cache is not fast enough to make it worthwhile. For single data-center setups, this can
2428 * simply be pointed to a cache in $wgWANObjectCaches that uses a local $wgObjectCaches
2429 * cache with a relayer of type EventRelayerNull.
2432 * - false: Configure the cache using $wgMainCacheType, without using
2433 * a relayer (only matters if there are multiple data-centers)
2434 * - CACHE_NONE: Do not cache
2435 * - (other): A string may be used which identifies a cache
2436 * configuration in $wgWANObjectCaches
2439 $wgMainWANCache = false;
2442 * Advanced WAN object cache configuration.
2444 * Each WAN cache wraps a registered object cache (for the local cluster)
2445 * and it must also be configured to point to a PubSub instance. Subscribers
2446 * must be configured to relay purges to the actual cache servers.
2448 * The format is an associative array where the key is a cache identifier, and
2449 * the value is an associative array of parameters. The "cacheId" parameter is
2450 * a cache identifier from $wgObjectCaches. The "loggroup" parameter controls
2451 * where log events are sent.
2455 $wgWANObjectCaches = [
2457 'class' => WANObjectCache
::class,
2458 'cacheId' => CACHE_NONE
2460 /* Example of a simple single data-center cache:
2461 'memcached-php' => [
2462 'class' => WANObjectCache::class,
2463 'cacheId' => 'memcached-php'
2469 * Verify and enforce WAN cache purges using reliable DB sources as streams.
2471 * These secondary cache purges are de-duplicated via simple cache mutexes.
2472 * This improves consistency when cache purges are lost, which becomes more likely
2473 * as more cache servers are added or if there are multiple datacenters. Only keys
2474 * related to important mutable content will be checked.
2479 $wgEnableWANCacheReaper = false;
2482 * The object store type of the main stash.
2484 * This store should be a very fast storage system optimized for holding lightweight data
2485 * like incrementable hit counters and current user activity. The store should replicate the
2486 * dataset among all data-centers. Any add(), merge(), lock(), and unlock() operations should
2487 * maintain "best effort" linearizability; as long as connectivity is strong, latency is low,
2488 * and there is no eviction pressure prompted by low free space, those operations should be
2489 * linearizable. In terms of PACELC (https://en.wikipedia.org/wiki/PACELC_theorem), the store
2490 * should act as a PA/EL distributed system for these operations. One optimization for these
2491 * operations is to route them to a "primary" data-center (e.g. one that serves HTTP POST) for
2492 * synchronous execution and then replicate to the others asynchronously. This means that at
2493 * least calls to these operations during HTTP POST requests would quickly return.
2495 * All other operations, such as get(), set(), delete(), changeTTL(), incr(), and decr(),
2496 * should be synchronous in the local data-center, replicating asynchronously to the others.
2497 * This behavior can be overriden by the use of the WRITE_SYNC and READ_LATEST flags.
2499 * The store should *preferably* have eventual consistency to handle network partitions.
2501 * Modules that rely on the stash should be prepared for:
2502 * - add(), merge(), lock(), and unlock() to be slower than other write operations,
2503 * at least in "secondary" data-centers (e.g. one that only serves HTTP GET/HEAD)
2504 * - Other write operations to have race conditions accross data-centers
2505 * - Read operations to have race conditions accross data-centers
2506 * - Consistency to be either eventual (with Last-Write-Wins) or just "best effort"
2508 * In general, this means avoiding updates during idempotent HTTP requests (GET/HEAD) and
2509 * avoiding assumptions of true linearizability (e.g. accepting anomalies). Modules that need
2510 * these kind of guarantees should use other storage mediums.
2513 * - db: Store cache objects in the DB
2514 * - (other): A string may be used which identifies a cache
2515 * configuration in $wgObjectCaches
2519 $wgMainStash = 'db-replicated';
2522 * The expiry time for the parser cache, in seconds.
2523 * The default is 86400 (one day).
2525 $wgParserCacheExpireTime = 86400;
2528 * The expiry time to use for session storage, in seconds.
2530 $wgObjectCacheSessionExpiry = 3600;
2533 * Whether to use PHP session handling ($_SESSION and session_*() functions)
2535 * If the constant MW_NO_SESSION is defined, this is forced to 'disable'.
2537 * If the constant MW_NO_SESSION_HANDLER is defined, this is ignored and PHP
2538 * session handling will function independently of SessionHandler.
2539 * SessionHandler and PHP's session handling may attempt to override each
2544 * - 'enable': Integrate with PHP's session handling as much as possible.
2545 * - 'warn': Integrate but log warnings if anything changes $_SESSION.
2546 * - 'disable': Throw exceptions if PHP session handling is used.
2548 $wgPHPSessionHandling = 'enable';
2551 * Number of internal PBKDF2 iterations to use when deriving session secrets.
2555 $wgSessionPbkdf2Iterations = 10001;
2558 * The list of MemCached servers and port numbers
2560 $wgMemCachedServers = [ '127.0.0.1:11211' ];
2563 * Use persistent connections to MemCached, which are shared across multiple
2566 $wgMemCachedPersistent = false;
2569 * Read/write timeout for MemCached server communication, in microseconds.
2571 $wgMemCachedTimeout = 500000;
2574 * Set this to true to maintain a copy of the message cache on the local server.
2576 * This layer of message cache is in addition to the one configured by $wgMessageCacheType.
2578 * The local copy is put in APC. If APC is not installed, this setting does nothing.
2580 * Note that this is about the message cache, which stores interface messages
2581 * maintained as wiki pages. This is separate from the localisation cache for interface
2582 * messages provided by the software, which is configured by $wgLocalisationCacheConf.
2584 $wgUseLocalMessageCache = false;
2587 * Instead of caching everything, only cache those messages which have
2588 * been customised in the site content language. This means that
2589 * MediaWiki:Foo/ja is ignored if MediaWiki:Foo doesn't exist.
2590 * This option is probably only useful for translatewiki.net.
2592 $wgAdaptiveMessageCache = false;
2595 * Localisation cache configuration.
2597 * Used by Language::getLocalisationCache() to decide how to construct the
2598 * LocalisationCache instance. Associative array with keys:
2600 * class: The class to use for constructing the LocalisationCache object.
2601 * This may be overridden by extensions to a subclass of LocalisationCache.
2602 * Sub classes are expected to still honor the 'storeClass', 'storeDirectory'
2603 * and 'manualRecache' options where applicable.
2605 * storeClass: Which LCStore class implementation to use. This is optional.
2606 * The default LocalisationCache class offers the 'store' option
2607 * as abstraction for this.
2609 * store: How and where to store localisation cache data.
2610 * This option is ignored if 'storeClass' is explicitly set to a class name.
2612 * - 'detect' (default): Automatically select 'files' if 'storeDirectory'
2613 * or $wgCacheDirectory is set, and fall back to 'db' otherwise.
2614 * - 'files': Store in $wgCacheDirectory as CDB files.
2615 * - 'array': Store in $wgCacheDirectory as PHP static array files.
2616 * - 'db': Store in the l10n_cache database table.
2618 * storeDirectory: If the selected LCStore class puts its data in files, then it
2619 * will use this directory. If set to false (default), then
2620 * $wgCacheDirectory is used instead.
2622 * manualRecache: Set this to true to disable cache updates on web requests.
2623 * Use maintenance/rebuildLocalisationCache.php instead.
2625 $wgLocalisationCacheConf = [
2626 'class' => LocalisationCache
::class,
2627 'store' => 'detect',
2628 'storeClass' => false,
2629 'storeDirectory' => false,
2630 'manualRecache' => false,
2634 * Allow client-side caching of pages
2636 $wgCachePages = true;
2639 * Set this to current time to invalidate all prior cached pages. Affects both
2640 * client-side and server-side caching.
2641 * You can get the current date on your server by using the command:
2643 * date +%Y%m%d%H%M%S
2646 $wgCacheEpoch = '20030516000000';
2649 * Directory where GitInfo will look for pre-computed cache files. If false,
2650 * $wgCacheDirectory/gitinfo will be used.
2652 $wgGitInfoCacheDirectory = false;
2655 * This will cache static pages for non-logged-in users to reduce
2656 * database traffic on public sites. ResourceLoader requests to default
2657 * language and skins are cached as well as single module requests.
2659 $wgUseFileCache = false;
2662 * Depth of the subdirectory hierarchy to be created under
2663 * $wgFileCacheDirectory. The subdirectories will be named based on
2664 * the MD5 hash of the title. A value of 0 means all cache files will
2665 * be put directly into the main file cache directory.
2667 $wgFileCacheDepth = 2;
2670 * Append a configured value to the parser cache and the sitenotice key so
2671 * that they can be kept separate for some class of activity.
2673 $wgRenderHashAppend = '';
2676 * If on, the sidebar navigation links are cached for users with the
2677 * current language set. This can save a touch of load on a busy site
2678 * by shaving off extra message lookups.
2680 * However it is also fragile: changing the site configuration, or
2681 * having a variable $wgArticlePath, can produce broken links that
2682 * don't update as expected.
2684 $wgEnableSidebarCache = false;
2687 * Expiry time for the sidebar cache, in seconds
2689 $wgSidebarCacheExpiry = 86400;
2692 * When using the file cache, we can store the cached HTML gzipped to save disk
2693 * space. Pages will then also be served compressed to clients that support it.
2695 * Requires zlib support enabled in PHP.
2700 * Invalidate various caches when LocalSettings.php changes. This is equivalent
2701 * to setting $wgCacheEpoch to the modification time of LocalSettings.php, as
2702 * was previously done in the default LocalSettings.php file.
2704 * On high-traffic wikis, this should be set to false, to avoid the need to
2705 * check the file modification time, and to avoid the performance impact of
2706 * unnecessary cache invalidations.
2708 $wgInvalidateCacheOnLocalSettingsChange = true;
2711 * When loading extensions through the extension registration system, this
2712 * can be used to invalidate the cache. A good idea would be to set this to
2713 * one file, you can just `touch` that one to invalidate the cache
2717 * $wgExtensionInfoMtime = filemtime( "$IP/LocalSettings.php" );
2720 * If set to false, the mtime for each individual JSON file will be checked,
2721 * which can be slow if a large number of extensions are being loaded.
2725 $wgExtensionInfoMTime = false;
2727 /** @} */ # end of cache settings
2729 /************************************************************************//**
2730 * @name HTTP proxy (CDN) settings
2732 * Many of these settings apply to any HTTP proxy used in front of MediaWiki,
2733 * although they are sometimes still referred to as Squid settings for
2734 * historical reasons.
2736 * Achieving a high hit ratio with an HTTP proxy requires special configuration.
2737 * See https://www.mediawiki.org/wiki/Manual:Performance_tuning#Page_view_caching
2744 * Enable/disable CDN.
2746 * See https://www.mediawiki.org/wiki/Manual:Performance_tuning#Page_view_caching
2748 * @since 1.34 Renamed from $wgUseSquid.
2753 * Add X-Forwarded-Proto to the Vary and Key headers for API requests and
2754 * RSS/Atom feeds. Use this if you have an SSL termination setup
2755 * and need to split the cache between HTTP and HTTPS for API requests,
2756 * feed requests and HTTP redirect responses in order to prevent cache
2757 * pollution. This does not affect 'normal' requests to index.php other than
2760 $wgVaryOnXFP = false;
2763 * Internal server name as known to CDN, if different.
2767 * $wgInternalServer = 'http://yourinternal.tld:8000';
2770 $wgInternalServer = false;
2773 * Cache TTL for the CDN sent as s-maxage (without ESI) or
2774 * Surrogate-Control (with ESI). Without ESI, you should strip
2775 * out s-maxage in the CDN config.
2777 * 18000 seconds = 5 hours, more cache hits with 2678400 = 31 days.
2779 * @since 1.34 Renamed from $wgSquidMaxage
2781 $wgCdnMaxAge = 18000;
2784 * Cache timeout for the CDN when DB replica DB lag is high
2789 $wgCdnMaxageLagged = 30;
2792 * If set, any SquidPurge call on a URL or URLs will send a second purge no less than
2793 * this many seconds later via the job queue. This requires delayed job support.
2794 * This should be safely higher than the 'max lag' value in $wgLBFactoryConf, so that
2795 * replica DB lag does not cause page to be stuck in stales states in CDN.
2797 * This also fixes race conditions in two-tiered CDN setups (e.g. cdn2 => cdn1 => MediaWiki).
2798 * If a purge for a URL reaches cdn2 before cdn1 and a request reaches cdn2 for that URL,
2799 * it will populate the response from the stale cdn1 value. When cdn1 gets the purge, cdn2
2800 * will still be stale. If the rebound purge delay is safely higher than the time to relay
2801 * a purge to all nodes, then the rebound purge will clear cdn2 after cdn1 was cleared.
2805 $wgCdnReboundPurgeDelay = 0;
2808 * Cache timeout for the CDN when a response is known to be wrong or incomplete (due to load)
2812 $wgCdnMaxageSubstitute = 60;
2815 * Default maximum age for raw CSS/JS accesses
2817 * 300 seconds = 5 minutes.
2819 $wgForcedRawSMaxage = 300;
2822 * List of proxy servers to purge on changes; default port is 80. Use IP addresses.
2824 * When MediaWiki is running behind a proxy, it will trust X-Forwarded-For
2825 * headers sent/modified from these proxies when obtaining the remote IP address
2827 * For a list of trusted servers which *aren't* purged, see $wgSquidServersNoPurge.
2829 * @since 1.34 Renamed from $wgSquidServers.
2834 * As with $wgCdnServers, except these servers aren't purged on page changes;
2835 * use to set a list of trusted proxies, etc. Supports both individual IP
2836 * addresses and CIDR blocks.
2838 * @since 1.23 Supports CIDR ranges
2839 * @since 1.34 Renamed from $wgSquidServersNoPurge
2841 $wgCdnServersNoPurge = [];
2844 * Whether to use a Host header in purge requests sent to the proxy servers
2845 * configured in $wgCdnServers. Set this to false to support a CDN
2846 * configured in forward-proxy mode.
2848 * If this is set to true, a Host header will be sent, and only the path
2849 * component of the URL will appear on the request line, as if the request
2850 * were a non-proxy HTTP 1.1 request. Varnish only supports this style of
2851 * request. Squid supports this style of request only if reverse-proxy mode
2852 * (http_port ... accel) is enabled.
2854 * If this is set to false, no Host header will be sent, and the absolute URL
2855 * will be sent in the request line, as is the standard for an HTTP proxy
2856 * request in both HTTP 1.0 and 1.1. This style of request is not supported
2857 * by Varnish, but is supported by Squid in either configuration (forward or
2861 * @deprecated since 1.33, will always be true in a future release.
2863 $wgSquidPurgeUseHostHeader = true;
2866 * Routing configuration for HTCP multicast purging. Add elements here to
2867 * enable HTCP and determine which purges are sent where. If set to an empty
2868 * array, HTCP is disabled.
2870 * Each key in this array is a regular expression to match against the purged
2871 * URL, or an empty string to match all URLs. The purged URL is matched against
2872 * the regexes in the order specified, and the first rule whose regex matches
2873 * is used, all remaining rules will thus be ignored.
2875 * @par Example configuration to send purges for upload.wikimedia.org to one
2876 * multicast group and all other purges to another:
2878 * $wgHTCPRouting = [
2879 * '|^https?://upload\.wikimedia\.org|' => [
2880 * 'host' => '239.128.0.113',
2884 * 'host' => '239.128.0.112',
2890 * You can also pass an array of hosts to send purges too. This is useful when
2891 * you have several multicast groups or unicast address that should receive a
2892 * given purge. Multiple hosts support was introduced in MediaWiki 1.22.
2894 * @par Example of sending purges to multiple hosts:
2896 * $wgHTCPRouting = [
2898 * // Purges to text caches using multicast
2899 * [ 'host' => '239.128.0.114', 'port' => '4827' ],
2900 * // Purges to a hardcoded list of caches
2901 * [ 'host' => '10.88.66.1', 'port' => '4827' ],
2902 * [ 'host' => '10.88.66.2', 'port' => '4827' ],
2903 * [ 'host' => '10.88.66.3', 'port' => '4827' ],
2909 * @see $wgHTCPMulticastTTL
2911 $wgHTCPRouting = [];
2914 * HTCP multicast TTL.
2915 * @see $wgHTCPRouting
2917 $wgHTCPMulticastTTL = 1;
2920 * Should forwarded Private IPs be accepted?
2922 $wgUsePrivateIPs = false;
2924 /** @} */ # end of HTTP proxy settings
2926 /************************************************************************//**
2927 * @name Language, regional and character encoding settings
2932 * Site language code. See languages/data/Names.php for languages supported by
2933 * MediaWiki out of the box. Not all languages listed there have translations,
2934 * see languages/messages/ for the list of languages with some localisation.
2936 * Warning: Don't use any of MediaWiki's deprecated language codes listed in
2937 * LanguageCode::getDeprecatedCodeMapping or $wgDummyLanguageCodes, like "no"
2938 * for Norwegian (use "nb" instead). If you do, things will break unexpectedly.
2940 * This defines the default interface language for all users, but users can
2941 * change it in their preferences.
2943 * This also defines the language of pages in the wiki. The content is wrapped
2944 * in a html element with lang=XX attribute. This behavior can be overridden
2945 * via hooks, see Title::getPageLanguage.
2947 $wgLanguageCode = 'en';
2950 * Language cache size, or really how many languages can we handle
2951 * simultaneously without degrading to crawl speed.
2953 $wgLangObjCacheSize = 10;
2956 * Some languages need different word forms, usually for different cases.
2957 * Used in Language::convertGrammar().
2961 * $wgGrammarForms['en']['genitive']['car'] = 'car\'s';
2964 $wgGrammarForms = [];
2967 * Treat language links as magic connectors, not inline links
2969 $wgInterwikiMagic = true;
2972 * Hide interlanguage links from the sidebar
2974 $wgHideInterlanguageLinks = false;
2977 * List of additional interwiki prefixes that should be treated as
2978 * interlanguage links (i.e. placed in the sidebar).
2980 * - This will not do anything unless the prefixes are defined in the interwiki
2982 * - The display text for these custom interlanguage links will be fetched from
2983 * the system message "interlanguage-link-xyz" where xyz is the prefix in
2985 * - A friendly name for each site, used for tooltip text, may optionally be
2986 * placed in the system message "interlanguage-link-sitename-xyz" where xyz is
2987 * the prefix in this array.
2989 $wgExtraInterlanguageLinkPrefixes = [];
2992 * List of language names or overrides for default names in Names.php
2994 $wgExtraLanguageNames = [];
2997 * List of mappings from one language code to another.
2998 * This array makes the codes not appear as a selectable language on the
2999 * installer, and excludes them when running the transstat.php script.
3001 * In Setup.php, the variable $wgDummyLanguageCodes is created by combining
3002 * these codes with a list of "deprecated" codes, which are mostly leftovers
3003 * from renames or other legacy things, and the internal codes 'qqq' and 'qqx'.
3004 * If a mapping in $wgExtraLanguageCodes collide with a built-in mapping, the
3005 * value in $wgExtraLanguageCodes will be used.
3009 $wgExtraLanguageCodes = [
3010 // Language codes of macro languages, which get mapped to the main language
3011 'bh' => 'bho', // Bihari language family
3012 'no' => 'nb', // Norwegian language family
3014 // Language variants which get mapped to the main language
3015 'simple' => 'en', // Simple English
3019 * Functionally the same as $wgExtraLanguageCodes, but deprecated. Instead of
3020 * appending values to this array, append them to $wgExtraLanguageCodes.
3022 * @deprecated since 1.29
3024 $wgDummyLanguageCodes = [];
3027 * Set this to true to replace Arabic presentation forms with their standard
3028 * forms in the U+0600-U+06FF block. This only works if $wgLanguageCode is
3031 * Note that pages with titles containing presentation forms will become
3032 * inaccessible, run maintenance/cleanupTitles.php to fix this.
3034 * @deprecated since 1.33: in the future will always be true.
3036 $wgFixArabicUnicode = true;
3039 * Set this to true to replace ZWJ-based chillu sequences in Malayalam text
3040 * with their Unicode 5.1 equivalents. This only works if $wgLanguageCode is
3041 * set to "ml". Note that some clients (even new clients as of 2010) do not
3042 * support these characters.
3044 * If you enable this on an existing wiki, run maintenance/cleanupTitles.php to
3045 * fix any ZWJ sequences in existing page titles.
3047 * @deprecated since 1.33: in the future will always be true.
3049 $wgFixMalayalamUnicode = true;
3052 * Set this to always convert certain Unicode sequences to modern ones
3053 * regardless of the content language. This has a small performance
3056 * See $wgFixArabicUnicode and $wgFixMalayalamUnicode for conversion
3061 $wgAllUnicodeFixes = false;
3064 * Set this to eg 'ISO-8859-1' to perform character set conversion when
3065 * loading old revisions not marked with "utf-8" flag. Use this when
3066 * converting a wiki from MediaWiki 1.4 or earlier to UTF-8 without the
3067 * burdensome mass conversion of old text data.
3069 * @note This DOES NOT touch any fields other than old_text. Titles, comments,
3070 * user names, etc still must be converted en masse in the database before
3071 * continuing as a UTF-8 wiki.
3073 $wgLegacyEncoding = false;
3076 * If set to true, the MediaWiki 1.4 to 1.5 schema conversion will
3077 * create stub reference rows in the text table instead of copying
3078 * the full text of all current entries from 'cur' to 'text'.
3080 * This will speed up the conversion step for large sites, but
3081 * requires that the cur table be kept around for those revisions
3082 * to remain viewable.
3084 * This option affects the updaters *only*. Any present cur stub
3085 * revisions will be readable at runtime regardless of this setting.
3087 $wgLegacySchemaConversion = false;
3090 * Enable dates like 'May 12' instead of '12 May', if the default date format
3093 $wgAmericanDates = false;
3096 * For Hindi and Arabic use local numerals instead of Western style (0-9)
3097 * numerals in interface.
3099 $wgTranslateNumerals = true;
3102 * Translation using MediaWiki: namespace.
3103 * Interface messages will be loaded from the database.
3105 $wgUseDatabaseMessages = true;
3108 * Maximum entry size in the message cache, in bytes
3110 $wgMaxMsgCacheEntrySize = 10000;
3113 * Whether to enable language variant conversion.
3115 $wgDisableLangConversion = false;
3118 * Whether to enable language variant conversion for links.
3120 $wgDisableTitleConversion = false;
3123 * Default variant code, if false, the default will be the language code
3125 $wgDefaultLanguageVariant = false;
3128 * Whether to enable the pig Latin variant of English (en-x-piglatin),
3129 * used to ease variant development work.
3131 $wgUsePigLatinVariant = false;
3134 * Disabled variants array of language variant conversion.
3138 * $wgDisabledVariants[] = 'zh-mo';
3139 * $wgDisabledVariants[] = 'zh-my';
3142 $wgDisabledVariants = [];
3145 * Like $wgArticlePath, but on multi-variant wikis, this provides a
3146 * path format that describes which parts of the URL contain the
3151 * $wgLanguageCode = 'sr';
3152 * $wgVariantArticlePath = '/$2/$1';
3153 * $wgArticlePath = '/wiki/$1';
3156 * A link to /wiki/ would be redirected to /sr/Главна_страна
3158 * It is important that $wgArticlePath not overlap with possible values
3159 * of $wgVariantArticlePath.
3161 $wgVariantArticlePath = false;
3164 * Show a bar of language selection links in the user login and user
3165 * registration forms; edit the "loginlanguagelinks" message to
3168 $wgLoginLanguageSelector = false;
3171 * When translating messages with wfMessage(), it is not always clear what
3172 * should be considered UI messages and what should be content messages.
3174 * For example, for the English Wikipedia, there should be only one 'mainpage',
3175 * so when getting the link for 'mainpage', we should treat it as site content
3176 * and call ->inContentLanguage()->text(), but for rendering the text of the
3177 * link, we call ->text(). The code behaves this way by default. However,
3178 * sites like the Wikimedia Commons do offer different versions of 'mainpage'
3179 * and the like for different languages. This array provides a way to override
3180 * the default behavior.
3183 * To allow language-specific main page and community
3186 * $wgForceUIMsgAsContentMsg = [ 'mainpage', 'portal-url' ];
3189 $wgForceUIMsgAsContentMsg = [];
3192 * Fake out the timezone that the server thinks it's in. This will be used for
3193 * date display and not for what's stored in the DB. Leave to null to retain
3194 * your server's OS-based timezone value.
3196 * This variable is currently used only for signature formatting and for local
3197 * time/date parser variables ({{LOCALTIME}} etc.)
3199 * Timezones can be translated by editing MediaWiki messages of type
3200 * timezone-nameinlowercase like timezone-utc.
3202 * A list of usable timezones can found at:
3203 * https://www.php.net/manual/en/timezones.php
3207 * $wgLocaltimezone = 'UTC';
3208 * $wgLocaltimezone = 'GMT';
3209 * $wgLocaltimezone = 'PST8PDT';
3210 * $wgLocaltimezone = 'Europe/Sweden';
3211 * $wgLocaltimezone = 'CET';
3214 $wgLocaltimezone = null;
3217 * Set an offset from UTC in minutes to use for the default timezone setting
3218 * for anonymous users and new user accounts.
3220 * This setting is used for most date/time displays in the software, and is
3221 * overridable in user preferences. It is *not* used for signature timestamps.
3223 * By default, this will be set to match $wgLocaltimezone.
3225 $wgLocalTZoffset = null;
3228 * List of Unicode characters for which capitalization is overridden in
3229 * Language::ucfirst. The characters should be
3230 * represented as char_to_convert => conversion_override. See T219279 for details
3231 * on why this is useful during php version transitions.
3233 * @warning: EXPERIMENTAL!
3238 $wgOverrideUcfirstCharacters = [];
3240 /** @} */ # End of language/charset settings
3242 /*************************************************************************//**
3243 * @name Output format and skin settings
3248 * The default Content-Type header.
3250 $wgMimeType = 'text/html';
3253 * Defines the value of the version attribute in the <html> tag, if any.
3255 * If your wiki uses RDFa, set it to the correct value for RDFa+HTML5.
3256 * Correct current values are 'HTML+RDFa 1.0' or 'XHTML+RDFa 1.0'.
3257 * See also https://www.w3.org/TR/rdfa-in-html/#document-conformance
3260 $wgHtml5Version = null;
3263 * Temporary variable that allows HTMLForms to be rendered as tables.
3264 * Table based layouts cause various issues when designing for mobile.
3265 * This global allows skins or extensions a means to force non-table based rendering.
3266 * Setting to false forces form components to always render as div elements.
3269 $wgHTMLFormAllowTableFormat = true;
3272 * Temporary variable that applies MediaWiki UI wherever it can be supported.
3273 * Temporary variable that should be removed when mediawiki ui is more
3274 * stable and change has been communicated.
3277 $wgUseMediaWikiUIEverywhere = false;
3280 * Whether to label the store-to-database-and-show-to-others button in the editor
3281 * as "Save page"/"Save changes" if false (the default) or, if true, instead as
3282 * "Publish page"/"Publish changes".
3286 $wgEditSubmitButtonLabelPublish = false;
3289 * Permit other namespaces in addition to the w3.org default.
3291 * Use the prefix for the key and the namespace for the value.
3295 * $wgXhtmlNamespaces['svg'] = 'http://www.w3.org/2000/svg';
3297 * Normally we wouldn't have to define this in the root "<html>"
3298 * element, but IE needs it there in some circumstances.
3300 * This is ignored if $wgMimeType is set to a non-XML MIME type.
3302 $wgXhtmlNamespaces = [];
3305 * Site notice shown at the top of each page
3307 * MediaWiki:Sitenotice page, which will override this. You can also
3308 * provide a separate message for logged-out users using the
3309 * MediaWiki:Anonnotice page.
3314 * Default skin, for new users and anonymous visitors. Registered users may
3315 * change this to any one of the other available skins in their preferences.
3317 $wgDefaultSkin = 'vector';
3320 * Fallback skin used when the skin defined by $wgDefaultSkin can't be found.
3324 $wgFallbackSkin = 'fallback';
3327 * Specify the names of skins that should not be presented in the list of
3328 * available skins in user preferences. If you want to remove a skin entirely,
3329 * remove it from the skins/ directory and its entry from LocalSettings.php.
3334 * @deprecated since 1.23; use $wgSkipSkins instead
3339 * Allow user Javascript page?
3340 * This enables a lot of neat customizations, but may
3341 * increase security risk to users and server load.
3343 $wgAllowUserJs = false;
3346 * Allow user Cascading Style Sheets (CSS)?
3347 * This enables a lot of neat customizations, but may
3348 * increase security risk to users and server load.
3350 $wgAllowUserCss = false;
3353 * Allow style-related user-preferences?
3355 * This controls whether the `editfont` and `underline` preferences
3356 * are available to users.
3358 $wgAllowUserCssPrefs = true;
3361 * Use the site's Javascript page?
3363 $wgUseSiteJs = true;
3366 * Use the site's Cascading Style Sheets (CSS)?
3368 $wgUseSiteCss = true;
3371 * Break out of framesets. This can be used to prevent clickjacking attacks,
3372 * or to prevent external sites from framing your site with ads.
3374 $wgBreakFrames = false;
3377 * The X-Frame-Options header to send on pages sensitive to clickjacking
3378 * attacks, such as edit pages. This prevents those pages from being displayed
3379 * in a frame or iframe. The options are:
3381 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3383 * - 'SAMEORIGIN': Allow framing by pages on the same domain. This can be used
3384 * to allow framing within a trusted domain. This is insecure if there
3385 * is a page on the same domain which allows framing of arbitrary URLs.
3387 * - false: Allow all framing. This opens up the wiki to XSS attacks and thus
3388 * full compromise of local user accounts. Private wikis behind a
3389 * corporate firewall are especially vulnerable. This is not
3392 * For extra safety, set $wgBreakFrames = true, to prevent framing on all pages,
3393 * not just edit pages.
3395 $wgEditPageFrameOptions = 'DENY';
3398 * Disallow framing of API pages directly, by setting the X-Frame-Options
3399 * header. Since the API returns CSRF tokens, allowing the results to be
3400 * framed can compromise your user's account security.
3402 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3403 * - 'SAMEORIGIN': Allow framing by pages on the same domain.
3404 * - false: Allow all framing.
3405 * Note: $wgBreakFrames will override this for human formatted API output.
3407 $wgApiFrameOptions = 'DENY';
3410 * Disable output compression (enabled by default if zlib is available)
3412 $wgDisableOutputCompression = false;
3415 * How should section IDs be encoded?
3416 * This array can contain 1 or 2 elements, each of them can be one of:
3417 * - 'html5' is modern HTML5 style encoding with minimal escaping. Displays Unicode
3418 * characters in most browsers' address bars.
3419 * - 'legacy' is old MediaWiki-style encoding, e.g. 啤酒 turns into .E5.95.A4.E9.85.92
3421 * The first element of this array specifies the primary mode of escaping IDs. This
3422 * is what users will see when they e.g. follow an [[#internal link]] to a section of
3425 * The optional second element defines a fallback mode, useful for migrations.
3426 * If present, it will direct MediaWiki to add empty <span>s to every section with its
3427 * id attribute set to fallback encoded title so that links using the previous encoding
3430 * Example: you want to migrate your wiki from 'legacy' to 'html5'
3432 * On the first step, set this variable to [ 'legacy', 'html5' ]. After a while, when
3433 * all caches (parser, HTTP, etc.) contain only pages generated with this setting,
3434 * flip the value to [ 'html5', 'legacy' ]. This will result in all internal links being
3435 * generated in the new encoding while old links (both external and cached internal) will
3436 * still work. After a long time, you might want to ditch backwards compatibility and
3437 * set it to [ 'html5' ]. After all, pages get edited, breaking incoming links no matter which
3438 * fragment mode is used.
3442 $wgFragmentMode = [ 'legacy', 'html5' ];
3445 * Which ID escaping mode should be used for external interwiki links? See documentation
3446 * for $wgFragmentMode above for details of each mode. Because you can't control external sites,
3447 * this setting should probably always be 'legacy', unless every wiki you link to has converted
3452 $wgExternalInterwikiFragmentMode = 'legacy';
3455 * Abstract list of footer icons for skins in place of old copyrightico and poweredbyico code
3456 * You can add new icons to the built in copyright or poweredby, or you can create
3457 * a new block. Though note that you may need to add some custom css to get good styling
3458 * of new blocks in monobook. vector and modern should work without any special css.
3460 * $wgFooterIcons itself is a key/value array.
3461 * The key is the name of a block that the icons will be wrapped in. The final id varies
3462 * by skin; Monobook and Vector will turn poweredby into f-poweredbyico while Modern
3463 * turns it into mw_poweredby.
3464 * The value is either key/value array of icons or a string.
3465 * In the key/value array the key may or may not be used by the skin but it can
3466 * be used to find the icon and unset it or change the icon if needed.
3467 * This is useful for disabling icons that are set by extensions.
3468 * The value should be either a string or an array. If it is a string it will be output
3469 * directly as html, however some skins may choose to ignore it. An array is the preferred format
3470 * for the icon, the following keys are used:
3471 * - src: An absolute url to the image to use for the icon, this is recommended
3472 * but not required, however some skins will ignore icons without an image
3473 * - srcset: optional additional-resolution images; see HTML5 specs
3474 * - url: The url to use in the a element around the text or icon, if not set an a element will
3476 * - alt: This is the text form of the icon, it will be displayed without an image in
3477 * skins like Modern or if src is not set, and will otherwise be used as
3478 * the alt="" for the image. This key is required.
3479 * - width and height: If the icon specified by src is not of the standard size
3480 * you can specify the size of image to use with these keys.
3481 * Otherwise they will default to the standard 88x31.
3482 * @todo Reformat documentation.
3486 "copyright" => [], // placeholder for the built in copyright icon
3490 // Defaults to point at
3491 // "$wgResourceBasePath/resources/assets/poweredby_mediawiki_88x31.png"
3492 // plus srcset for 1.5x, 2x resolution variants.
3494 "url" => "https://www.mediawiki.org/",
3495 "alt" => "Powered by MediaWiki",
3501 * Login / create account link behavior when it's possible for anonymous users
3502 * to create an account.
3503 * - true = use a combined login / create account link
3504 * - false = split login and create account into two separate links
3506 $wgUseCombinedLoginLink = false;
3509 * Display user edit counts in various prominent places.
3511 $wgEdititis = false;
3514 * Some web hosts attempt to rewrite all responses with a 404 (not found)
3515 * status code, mangling or hiding MediaWiki's output. If you are using such a
3516 * host, you should start looking for a better one. While you're doing that,
3517 * set this to false to convert some of MediaWiki's 404 responses to 200 so
3518 * that the generated error pages can be seen.
3520 * In cases where for technical reasons it is more important for MediaWiki to
3521 * send the correct status code than for the body to be transmitted intact,
3522 * this configuration variable is ignored.
3524 $wgSend404Code = true;
3527 * The $wgShowRollbackEditCount variable is used to show how many edits can be rolled back.
3528 * The numeric value of the variable controls how many edits MediaWiki will look back to
3529 * determine whether a rollback is allowed (by checking that they are all from the same author).
3530 * If the value is false or 0, the edits are not counted. Disabling this will prevent MediaWiki
3531 * from hiding some useless rollback links.
3535 $wgShowRollbackEditCount = 10;
3538 * Output a <link rel="canonical"> tag on every page indicating the canonical
3539 * server which should be used, i.e. $wgServer or $wgCanonicalServer. Since
3540 * detection of the current server is unreliable, the link is sent
3543 $wgEnableCanonicalServerLink = false;
3546 * When OutputHandler is used, mangle any output that contains
3547 * <cross-domain-policy>. Without this, an attacker can send their own
3548 * cross-domain policy unless it is prevented by the crossdomain.xml file at
3553 $wgMangleFlashPolicy = true;
3555 /** @} */ # End of output format settings }
3557 /*************************************************************************//**
3558 * @name ResourceLoader settings