3 * Default values for MediaWiki configuration settings.
9 * To customize your installation, edit "LocalSettings.php". If you make
10 * changes here, they will be lost on next upgrade of MediaWiki!
12 * In this file, variables whose default values depend on other
13 * variables are set to false. The actual default value of these variables
14 * will only be set in Setup.php, taking into account any custom settings
15 * performed in LocalSettings.php.
17 * Documentation is in the source and on:
18 * https://www.mediawiki.org/wiki/Manual:Configuration_settings
20 * @warning Note: this (and other things) will break if the autoloader is not
21 * enabled. Please include includes/AutoLoader.php before including this file.
23 * This program is free software; you can redistribute it and/or modify
24 * it under the terms of the GNU General Public License as published by
25 * the Free Software Foundation; either version 2 of the License, or
26 * (at your option) any later version.
28 * This program is distributed in the hope that it will be useful,
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31 * GNU General Public License for more details.
33 * You should have received a copy of the GNU General Public License along
34 * with this program; if not, write to the Free Software Foundation, Inc.,
35 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
36 * http://www.gnu.org/copyleft/gpl.html
42 * @cond file_level_code
43 * This is not a valid entry point, perform no further processing unless
44 * MEDIAWIKI is defined
46 if ( !defined( 'MEDIAWIKI' ) ) {
47 echo "This file is part of MediaWiki and is not a valid entry point\n";
54 * wgConf hold the site configuration.
55 * Not used for much in a default install.
58 $wgConf = new SiteConfiguration
;
61 * Registry of factory functions to create config objects:
62 * The 'main' key must be set, and the value should be a valid
67 'main' => 'GlobalVarConfig::newInstance'
71 * MediaWiki version number
74 $wgVersion = '1.31.0-rc.2';
77 * Name of the site. It must be changed in LocalSettings.php
79 $wgSitename = 'MediaWiki';
82 * When the wiki is running behind a proxy and this is set to true, assumes that the proxy exposes
83 * the wiki on the standard ports (443 for https and 80 for http).
87 $wgAssumeProxiesUseDefaultProtocolPorts = true;
94 * $wgServer = 'http://example.com';
97 * This is usually detected correctly by MediaWiki. If MediaWiki detects the
98 * wrong server, it will redirect incorrectly after you save a page. In that
99 * case, set this variable to fix it.
101 * If you want to use protocol-relative URLs on your wiki, set this to a
102 * protocol-relative URL like '//example.com' and set $wgCanonicalServer
103 * to a fully qualified URL.
105 $wgServer = WebRequest
::detectServer();
108 * Canonical URL of the server, to use in IRC feeds and notification e-mails.
109 * Must be fully qualified, even if $wgServer is protocol-relative.
111 * Defaults to $wgServer, expanded to a fully qualified http:// URL if needed.
114 $wgCanonicalServer = false;
117 * Server name. This is automatically computed by parsing the bare
118 * hostname out of $wgCanonicalServer. It should not be customized.
121 $wgServerName = false;
123 /************************************************************************//**
124 * @name Script path settings
129 * The path we should point to.
130 * It might be a virtual path in case with use apache mod_rewrite for example.
132 * This *needs* to be set correctly.
134 * Other paths will be set to defaults based on it unless they are directly
135 * set in LocalSettings.php
137 $wgScriptPath = '/wiki';
140 * Whether to support URLs like index.php/Page_title These often break when PHP
141 * is set up in CGI mode. PATH_INFO *may* be correct if cgi.fix_pathinfo is set,
142 * but then again it may not; lighttpd converts incoming path data to lowercase
143 * on systems with case-insensitive filesystems, and there have been reports of
144 * problems on Apache as well.
146 * To be safe we'll continue to keep it off by default.
148 * Override this to false if $_SERVER['PATH_INFO'] contains unexpectedly
149 * incorrect garbage, or to true if it is really correct.
151 * The default $wgArticlePath will be set based on this value at runtime, but if
152 * you have customized it, having this incorrectly set to true can cause
153 * redirect loops when "pretty URLs" are used.
156 $wgUsePathInfo = ( strpos( PHP_SAPI
, 'cgi' ) === false ) &&
157 ( strpos( PHP_SAPI
, 'apache2filter' ) === false ) &&
158 ( strpos( PHP_SAPI
, 'isapi' ) === false );
162 /************************************************************************//**
163 * @name URLs and file paths
165 * These various web and file path variables are set to their defaults
166 * in Setup.php if they are not explicitly set from LocalSettings.php.
168 * These will relatively rarely need to be set manually, unless you are
169 * splitting style sheets or images outside the main document root.
171 * In this section, a "path" is usually a host-relative URL, i.e. a URL without
172 * the host part, that starts with a slash. In most cases a full URL is also
173 * acceptable. A "directory" is a local file path.
175 * In both paths and directories, trailing slashes should not be included.
181 * The URL path to index.php.
183 * Defaults to "{$wgScriptPath}/index.php".
188 * The URL path to load.php.
190 * Defaults to "{$wgScriptPath}/load.php".
193 $wgLoadScript = false;
196 * The URL path of the skins directory.
197 * Defaults to "{$wgResourceBasePath}/skins".
200 $wgStylePath = false;
201 $wgStyleSheetPath = &$wgStylePath;
204 * The URL path of the skins directory. Should not point to an external domain.
205 * Defaults to "{$wgScriptPath}/skins".
208 $wgLocalStylePath = false;
211 * The URL path of the extensions directory.
212 * Defaults to "{$wgResourceBasePath}/extensions".
215 $wgExtensionAssetsPath = false;
218 * Filesystem extensions directory.
219 * Defaults to "{$IP}/extensions".
222 $wgExtensionDirectory = "{$IP}/extensions";
225 * Filesystem stylesheets directory.
226 * Defaults to "{$IP}/skins".
229 $wgStyleDirectory = "{$IP}/skins";
232 * The URL path for primary article page views. This path should contain $1,
233 * which is replaced by the article title.
235 * Defaults to "{$wgScript}/$1" or "{$wgScript}?title=$1",
236 * depending on $wgUsePathInfo.
238 $wgArticlePath = false;
241 * The URL path for the images directory.
242 * Defaults to "{$wgScriptPath}/images".
244 $wgUploadPath = false;
247 * The filesystem path of the images directory. Defaults to "{$IP}/images".
249 $wgUploadDirectory = false;
252 * Directory where the cached page will be saved.
253 * Defaults to "{$wgUploadDirectory}/cache".
255 $wgFileCacheDirectory = false;
258 * The URL path of the wiki logo. The logo size should be 135x135 pixels.
259 * Defaults to "$wgResourceBasePath/resources/assets/wiki.png".
264 * Array with URL paths to HD versions of the wiki logo. The scaled logo size
265 * should be under 135x155 pixels.
266 * Only 1.5x and 2x versions are supported.
271 * "1.5x" => "path/to/1.5x_version.png",
272 * "2x" => "path/to/2x_version.png"
276 * SVG is also supported but when enabled, it
277 * disables 1.5x and 2x as svg will already
278 * be optimised for screen resolution.
283 * "svg" => "path/to/svg_version.svg",
292 * The URL path of the shortcut icon.
295 $wgFavicon = '/favicon.ico';
298 * The URL path of the icon for iPhone and iPod Touch web app bookmarks.
299 * Defaults to no icon.
302 $wgAppleTouchIcon = false;
305 * Value for the referrer policy meta tag.
306 * One or more of the values defined in the Referrer Policy specification:
307 * https://w3c.github.io/webappsec-referrer-policy/
308 * ('no-referrer', 'no-referrer-when-downgrade', 'same-origin',
309 * 'origin', 'strict-origin', 'origin-when-cross-origin',
310 * 'strict-origin-when-cross-origin', or 'unsafe-url')
311 * Setting it to false prevents the meta tag from being output
312 * (which results in falling back to the Referrer-Policy header,
313 * or 'no-referrer-when-downgrade' if that's not set either.)
314 * Setting it to an array (supported since 1.31) will create a meta tag for
315 * each value, in the reverse of the order (meaning that the first array element
316 * will be the default and the others used as fallbacks for browsers which do not
319 * @var array|string|bool
322 $wgReferrerPolicy = false;
325 * The local filesystem path to a temporary directory. This is not required to
328 * When this setting is set to false, its value will be set through a call
329 * to wfTempDir(). See that methods implementation for the actual detection
332 * Developers should use the global function wfTempDir() instead of this
336 * @note Default changed to false in MediaWiki 1.20.
338 $wgTmpDirectory = false;
341 * If set, this URL is added to the start of $wgUploadPath to form a complete
345 $wgUploadBaseUrl = '';
348 * To enable remote on-demand scaling, set this to the thumbnail base URL.
349 * Full thumbnail URL will be like $wgUploadStashScalerBaseUrl/e/e6/Foo.jpg/123px-Foo.jpg
350 * where 'e6' are the first two characters of the MD5 hash of the file name.
351 * If $wgUploadStashScalerBaseUrl is set to false, thumbs are rendered locally as needed.
354 $wgUploadStashScalerBaseUrl = false;
357 * To set 'pretty' URL paths for actions other than
358 * plain page views, add to this array.
361 * Set pretty URL for the edit action:
363 * 'edit' => "$wgScriptPath/edit/$1"
366 * There must be an appropriate script or rewrite rule in place to handle these
374 /************************************************************************//**
375 * @name Files and file uploads
380 * Uploads have to be specially set up to be secure
382 $wgEnableUploads = false;
385 * The maximum age of temporary (incomplete) uploaded files
387 $wgUploadStashMaxAge = 6 * 3600; // 6 hours
390 * Allows to move images and other media files
392 $wgAllowImageMoving = true;
395 * Enable deferred upload tasks that use the job queue.
396 * Only enable this if job runners are set up for both the
397 * 'AssembleUploadChunks' and 'PublishStashedFile' job types.
399 * @note If you use suhosin, this setting is incompatible with
400 * suhosin.session.encrypt.
402 $wgEnableAsyncUploads = false;
405 * Additional characters that are not allowed in filenames. They are replaced with '-' when
406 * uploading. Like $wgLegalTitleChars, this is a regexp character class.
408 * Slashes and backslashes are disallowed regardless of this setting, but included here for
411 $wgIllegalFileChars = ":\\/\\\\";
414 * What directory to place deleted uploads in.
415 * Defaults to "{$wgUploadDirectory}/deleted".
417 $wgDeletedDirectory = false;
420 * Set this to true if you use img_auth and want the user to see details on why access failed.
422 $wgImgAuthDetails = false;
425 * Map of relative URL directories to match to internal mwstore:// base storage paths.
426 * For img_auth.php requests, everything after "img_auth.php/" is checked to see
427 * if starts with any of the prefixes defined here. The prefixes should not overlap.
428 * The prefix that matches has a corresponding storage path, which the rest of the URL
429 * is assumed to be relative to. The file at that path (or a 404) is send to the client.
432 * $wgImgAuthUrlPathMap['/timeline/'] = 'mwstore://local-fs/timeline-render/';
433 * The above maps ".../img_auth.php/timeline/X" to "mwstore://local-fs/timeline-render/".
434 * The name "local-fs" should correspond by name to an entry in $wgFileBackends.
436 * @see $wgFileBackends
438 $wgImgAuthUrlPathMap = [];
441 * File repository structures
443 * $wgLocalFileRepo is a single repository structure, and $wgForeignFileRepos is
444 * an array of such structures. Each repository structure is an associative
445 * array of properties configuring the repository.
447 * Properties required for all repos:
448 * - class The class name for the repository. May come from the core or an extension.
449 * The core repository classes are FileRepo, LocalRepo, ForeignDBRepo.
451 * - name A unique name for the repository (but $wgLocalFileRepo should be 'local').
452 * The name should consist of alpha-numeric characters.
453 * - backend A file backend name (see $wgFileBackends).
455 * For most core repos:
456 * - zones Associative array of zone names that each map to an array with:
457 * container : backend container name the zone is in
458 * directory : root path within container for the zone
459 * url : base URL to the root of the zone
460 * urlsByExt : map of file extension types to base URLs
461 * (useful for using a different cache for videos)
462 * Zones default to using "<repo name>-<zone name>" as the container name
463 * and default to using the container root as the zone's root directory.
464 * Nesting of zone locations within other zones should be avoided.
465 * - url Public zone URL. The 'zones' settings take precedence.
466 * - hashLevels The number of directory levels for hash-based division of files
467 * - thumbScriptUrl The URL for thumb.php (optional, not recommended)
468 * - transformVia404 Whether to skip media file transformation on parse and rely on a 404
470 * - initialCapital Equivalent to $wgCapitalLinks (or $wgCapitalLinkOverrides[NS_FILE],
471 * determines whether filenames implicitly start with a capital letter.
472 * The current implementation may give incorrect description page links
473 * when the local $wgCapitalLinks and initialCapital are mismatched.
474 * - pathDisclosureProtection
475 * May be 'paranoid' to remove all parameters from error messages, 'none' to
476 * leave the paths in unchanged, or 'simple' to replace paths with
477 * placeholders. Default for LocalRepo is 'simple'.
478 * - fileMode This allows wikis to set the file mode when uploading/moving files. Default
480 * - directory The local filesystem directory where public files are stored. Not used for
482 * - thumbDir The base thumbnail directory. Defaults to "<directory>/thumb".
483 * - thumbUrl The base thumbnail URL. Defaults to "<url>/thumb".
484 * - isPrivate Set this if measures should always be taken to keep the files private.
485 * One should not trust this to assure that the files are not web readable;
486 * the server configuration should be done manually depending on the backend.
488 * These settings describe a foreign MediaWiki installation. They are optional, and will be ignored
489 * for local repositories:
490 * - descBaseUrl URL of image description pages, e.g. https://en.wikipedia.org/wiki/File:
491 * - scriptDirUrl URL of the MediaWiki installation, equivalent to $wgScriptPath, e.g.
492 * https://en.wikipedia.org/w
493 * - articleUrl Equivalent to $wgArticlePath, e.g. https://en.wikipedia.org/wiki/$1
494 * - fetchDescription Fetch the text of the remote file description page. Equivalent to
495 * $wgFetchCommonsDescriptions.
496 * - abbrvThreshold File names over this size will use the short form of thumbnail names.
497 * Short thumbnail names only have the width, parameters, and the extension.
500 * - dbType, dbServer, dbUser, dbPassword, dbName, dbFlags
501 * equivalent to the corresponding member of $wgDBservers
502 * - tablePrefix Table prefix, the foreign wiki's $wgDBprefix
503 * - hasSharedCache True if the wiki's shared cache is accessible via the local $wgMemc
506 * - apibase Use for the foreign API's URL
507 * - apiThumbCacheExpiry How long to locally cache thumbs for
509 * If you leave $wgLocalFileRepo set to false, Setup will fill in appropriate values.
510 * Otherwise, set $wgLocalFileRepo to a repository structure as described above.
511 * If you set $wgUseInstantCommons to true, it will add an entry for Commons.
512 * If you set $wgForeignFileRepos to an array of repository structures, those will
513 * be searched after the local file repo.
514 * Otherwise, you will only have access to local media files.
516 * @see Setup.php for an example usage and default initialization.
518 $wgLocalFileRepo = false;
521 * @see $wgLocalFileRepo
523 $wgForeignFileRepos = [];
526 * Use Commons as a remote file repository. Essentially a wrapper, when this
527 * is enabled $wgForeignFileRepos will point at Commons with a set of default
530 $wgUseInstantCommons = false;
533 * Array of foreign file repo names (set in $wgForeignFileRepos above) that
534 * are allowable upload targets. These wikis must have some method of
535 * authentication (i.e. CentralAuth), and be CORS-enabled for this wiki.
536 * The string 'local' signifies the default local file repository.
539 * $wgForeignUploadTargets = [ 'shared' ];
541 $wgForeignUploadTargets = [ 'local' ];
544 * Configuration for file uploads using the embeddable upload dialog
545 * (https://www.mediawiki.org/wiki/Upload_dialog).
547 * This applies also to foreign uploads to this wiki (the configuration is loaded by remote wikis
548 * using the action=query&meta=siteinfo API).
550 * See below for documentation of each property. None of the properties may be omitted.
553 // Fields to make available in the dialog. `true` means that this field is visible, `false` means
554 // that it is hidden. The "Name" field can't be hidden. Note that you also have to add the
555 // matching replacement to the 'filepage' format key below to make use of these.
557 'description' => true,
559 'categories' => false,
561 // Suffix of localisation messages used to describe the license under which the uploaded file will
562 // be released. The same value may be set for both 'local' and 'foreign' uploads.
563 'licensemessages' => [
564 // The 'local' messages are used for local uploads on this wiki:
565 // * upload-form-label-own-work-message-generic-local
566 // * upload-form-label-not-own-work-message-generic-local
567 // * upload-form-label-not-own-work-local-generic-local
568 'local' => 'generic-local',
569 // The 'foreign' messages are used for cross-wiki uploads from other wikis to this wiki:
570 // * upload-form-label-own-work-message-generic-foreign
571 // * upload-form-label-not-own-work-message-generic-foreign
572 // * upload-form-label-not-own-work-local-generic-foreign
573 'foreign' => 'generic-foreign',
575 // Upload comments to use for 'local' and 'foreign' uploads. This can also be set to a single
576 // string value, in which case it is used for both kinds of uploads. Available replacements:
577 // * $HOST - domain name from which a cross-wiki upload originates
578 // * $PAGENAME - wiki page name from which an upload originates
583 // Format of the file page wikitext to be generated from the fields input by the user.
585 // Wrapper for the whole page. Available replacements:
586 // * $DESCRIPTION - file description, as input by the user (only if the 'description' field is
587 // enabled), wrapped as defined below in the 'description' key
588 // * $DATE - file creation date, as input by the user (only if the 'date' field is enabled)
589 // * $SOURCE - as defined below in the 'ownwork' key, may be extended in the future
590 // * $AUTHOR - linked user name, may be extended in the future
591 // * $LICENSE - as defined below in the 'license' key, may be extended in the future
592 // * $CATEGORIES - file categories wikitext, as input by the user (only if the 'categories'
593 // field is enabled), or if no input, as defined below in the 'uncategorized' key
594 'filepage' => '$DESCRIPTION',
595 // Wrapped for file description. Available replacements:
596 // * $LANGUAGE - source wiki's content language
597 // * $TEXT - input by the user
598 'description' => '$TEXT',
601 'uncategorized' => '',
606 * File backend structure configuration.
608 * This is an array of file backend configuration arrays.
609 * Each backend configuration has the following parameters:
610 * - 'name' : A unique name for the backend
611 * - 'class' : The file backend class to use
612 * - 'wikiId' : A unique string that identifies the wiki (container prefix)
613 * - 'lockManager' : The name of a lock manager (see $wgLockManagers)
615 * See FileBackend::__construct() for more details.
616 * Additional parameters are specific to the file backend class used.
617 * These settings should be global to all wikis when possible.
619 * FileBackendMultiWrite::__construct() is augmented with a 'template' option that
620 * can be used in any of the values of the 'backends' array. Its value is the name of
621 * another backend in $wgFileBackends. When set, it pre-fills the array with all of the
622 * configuration of the named backend. Explicitly set values in the array take precedence.
624 * There are two particularly important aspects about each backend:
625 * - a) Whether it is fully qualified or wiki-relative.
626 * By default, the paths of files are relative to the current wiki,
627 * which works via prefixing them with the current wiki ID when accessed.
628 * Setting 'wikiId' forces the backend to be fully qualified by prefixing
629 * all paths with the specified value instead. This can be useful if
630 * multiple wikis need to share the same data. Note that 'name' is *not*
631 * part of any prefix and thus should not be relied upon for namespacing.
632 * - b) Whether it is only defined for some wikis or is defined on all
633 * wikis in the wiki farm. Defining a backend globally is useful
634 * if multiple wikis need to share the same data.
635 * One should be aware of these aspects when configuring a backend for use with
636 * any basic feature or plugin. For example, suppose an extension stores data for
637 * different wikis in different directories and sometimes needs to access data from
638 * a foreign wiki's directory in order to render a page on given wiki. The extension
639 * would need a fully qualified backend that is defined on all wikis in the wiki farm.
641 $wgFileBackends = [];
644 * Array of configuration arrays for each lock manager.
645 * Each backend configuration has the following parameters:
646 * - 'name' : A unique name for the lock manager
647 * - 'class' : The lock manger class to use
649 * See LockManager::__construct() for more details.
650 * Additional parameters are specific to the lock manager class used.
651 * These settings should be global to all wikis.
653 * When using DBLockManager, the 'dbsByBucket' map can reference 'localDBMaster' as
654 * a peer database in each bucket. This will result in an extra connection to the domain
655 * that the LockManager services, which must also be a valid wiki ID.
657 $wgLockManagers = [];
660 * Show Exif data, on by default if available.
661 * Requires PHP's Exif extension: https://secure.php.net/manual/en/ref.exif.php
663 * @note FOR WINDOWS USERS:
664 * To enable Exif functions, add the following line to the "Windows
665 * extensions" section of php.ini:
667 * extension=extensions/php_exif.dll
670 $wgShowEXIF = function_exists( 'exif_read_data' );
673 * If to automatically update the img_metadata field
674 * if the metadata field is outdated but compatible with the current version.
677 $wgUpdateCompatibleMetadata = false;
680 * If you operate multiple wikis, you can define a shared upload path here.
681 * Uploads to this wiki will NOT be put there - they will be put into
682 * $wgUploadDirectory.
683 * If $wgUseSharedUploads is set, the wiki will look in the shared repository if
684 * no file of the given name is found in the local repository (for [[File:..]],
685 * [[Media:..]] links). Thumbnails will also be looked for and generated in this
688 * Note that these configuration settings can now be defined on a per-
689 * repository basis for an arbitrary number of file repositories, using the
690 * $wgForeignFileRepos variable.
692 $wgUseSharedUploads = false;
695 * Full path on the web server where shared uploads can be found
697 $wgSharedUploadPath = null;
700 * Fetch commons image description pages and display them on the local wiki?
702 $wgFetchCommonsDescriptions = false;
705 * Path on the file system where shared uploads can be found.
707 $wgSharedUploadDirectory = null;
710 * DB name with metadata about shared directory.
711 * Set this to false if the uploads do not come from a wiki.
713 $wgSharedUploadDBname = false;
716 * Optional table prefix used in database.
718 $wgSharedUploadDBprefix = '';
721 * Cache shared metadata in memcached.
722 * Don't do this if the commons wiki is in a different memcached domain
724 $wgCacheSharedUploads = true;
727 * Allow for upload to be copied from an URL.
728 * The timeout for copy uploads is set by $wgCopyUploadTimeout.
729 * You have to assign the user right 'upload_by_url' to a user group, to use this.
731 $wgAllowCopyUploads = false;
734 * A list of domains copy uploads can come from
738 $wgCopyUploadsDomains = [];
741 * Enable copy uploads from Special:Upload. $wgAllowCopyUploads must also be
742 * true. If $wgAllowCopyUploads is true, but this is false, you will only be
743 * able to perform copy uploads from the API or extensions (e.g. UploadWizard).
745 $wgCopyUploadsFromSpecialUpload = false;
748 * Proxy to use for copy upload requests.
751 $wgCopyUploadProxy = false;
754 * Different timeout for upload by url
755 * This could be useful since when fetching large files, you may want a
756 * timeout longer than the default $wgHTTPTimeout. False means fallback
763 $wgCopyUploadTimeout = false;
766 * Max size for uploads, in bytes. If not set to an array, applies to all
767 * uploads. If set to an array, per upload type maximums can be set, using the
768 * file and url keys. If the * key is set this value will be used as maximum
769 * for non-specified types.
773 * $wgMaxUploadSize = [
775 * 'url' => 500 * 1024,
778 * Sets the maximum for all uploads to 250 kB except for upload-by-url, which
779 * will have a maximum of 500 kB.
781 $wgMaxUploadSize = 1024 * 1024 * 100; # 100MB
784 * Minimum upload chunk size, in bytes. When using chunked upload, non-final
785 * chunks smaller than this will be rejected. May be reduced based on the
786 * 'upload_max_filesize' or 'post_max_size' PHP settings.
789 $wgMinUploadChunkSize = 1024; # 1KB
792 * Point the upload navigation link to an external URL
793 * Useful if you want to use a shared repository by default
794 * without disabling local uploads (use $wgEnableUploads = false for that).
798 * $wgUploadNavigationUrl = 'https://commons.wikimedia.org/wiki/Special:Upload';
801 $wgUploadNavigationUrl = false;
804 * Point the upload link for missing files to an external URL, as with
805 * $wgUploadNavigationUrl. The URL will get "(?|&)wpDestFile=<filename>"
806 * appended to it as appropriate.
808 $wgUploadMissingFileUrl = false;
811 * Give a path here to use thumb.php for thumbnail generation on client
812 * request, instead of generating them on render and outputting a static URL.
813 * This is necessary if some of your apache servers don't have read/write
814 * access to the thumbnail path.
818 * $wgThumbnailScriptPath = "{$wgScriptPath}/thumb.php";
821 $wgThumbnailScriptPath = false;
824 * @see $wgThumbnailScriptPath
826 $wgSharedThumbnailScriptPath = false;
829 * Set this to false if you do not want MediaWiki to divide your images
830 * directory into many subdirectories, for improved performance.
832 * It's almost always good to leave this enabled. In previous versions of
833 * MediaWiki, some users set this to false to allow images to be added to the
834 * wiki by simply copying them into $wgUploadDirectory and then running
835 * maintenance/rebuildImages.php to register them in the database. This is no
836 * longer recommended, use maintenance/importImages.php instead.
838 * @note That this variable may be ignored if $wgLocalFileRepo is set.
839 * @todo Deprecate the setting and ultimately remove it from Core.
841 $wgHashedUploadDirectory = true;
844 * Set the following to false especially if you have a set of files that need to
845 * be accessible by all wikis, and you do not want to use the hash (path/a/aa/)
848 $wgHashedSharedUploadDirectory = true;
851 * Base URL for a repository wiki. Leave this blank if uploads are just stored
852 * in a shared directory and not meant to be accessible through a separate wiki.
853 * Otherwise the image description pages on the local wiki will link to the
854 * image description page on this wiki.
856 * Please specify the namespace, as in the example below.
858 $wgRepositoryBaseUrl = "https://commons.wikimedia.org/wiki/File:";
861 * This is the list of preferred extensions for uploading files. Uploading files
862 * with extensions not in this list will trigger a warning.
864 * @warning If you add any OpenOffice or Microsoft Office file formats here,
865 * such as odt or doc, and untrusted users are allowed to upload files, then
866 * your wiki will be vulnerable to cross-site request forgery (CSRF).
868 $wgFileExtensions = [ 'png', 'gif', 'jpg', 'jpeg', 'webp' ];
871 * Files with these extensions will never be allowed as uploads.
872 * An array of file extensions to blacklist. You should append to this array
873 * if you want to blacklist additional files.
876 # HTML may contain cookie-stealing JavaScript and web bugs
877 'html', 'htm', 'js', 'jsb', 'mhtml', 'mht', 'xhtml', 'xht',
878 # PHP scripts may execute arbitrary code on the server
879 'php', 'phtml', 'php3', 'php4', 'php5', 'phps',
880 # Other types that may be interpreted by some servers
881 'shtml', 'jhtml', 'pl', 'py', 'cgi',
882 # May contain harmful executables for Windows victims
883 'exe', 'scr', 'dll', 'msi', 'vbs', 'bat', 'com', 'pif', 'cmd', 'vxd', 'cpl' ];
886 * Files with these MIME types will never be allowed as uploads
887 * if $wgVerifyMimeType is enabled.
889 $wgMimeTypeBlacklist = [
890 # HTML may contain cookie-stealing JavaScript and web bugs
891 'text/html', 'text/javascript', 'text/x-javascript', 'application/x-shellscript',
892 # PHP scripts may execute arbitrary code on the server
893 'application/x-php', 'text/x-php',
894 # Other types that may be interpreted by some servers
895 'text/x-python', 'text/x-perl', 'text/x-bash', 'text/x-sh', 'text/x-csh',
896 # Client-side hazards on Internet Explorer
897 'text/scriptlet', 'application/x-msdownload',
898 # Windows metafile, client-side vulnerability on some systems
899 'application/x-msmetafile',
903 * Allow Java archive uploads.
904 * This is not recommended for public wikis since a maliciously-constructed
905 * applet running on the same domain as the wiki can steal the user's cookies.
907 $wgAllowJavaUploads = false;
910 * This is a flag to determine whether or not to check file extensions on upload.
912 * @warning Setting this to false is insecure for public wikis.
914 $wgCheckFileExtensions = true;
917 * If this is turned off, users may override the warning for files not covered
918 * by $wgFileExtensions.
920 * @warning Setting this to false is insecure for public wikis.
922 $wgStrictFileExtensions = true;
925 * Setting this to true will disable the upload system's checks for HTML/JavaScript.
927 * @warning THIS IS VERY DANGEROUS on a publicly editable site, so USE
928 * $wgGroupPermissions TO RESTRICT UPLOADING to only those that you trust
930 $wgDisableUploadScriptChecks = false;
933 * Warn if uploaded files are larger than this (in bytes), or false to disable
935 $wgUploadSizeWarning = false;
938 * list of trusted media-types and MIME types.
939 * Use the MEDIATYPE_xxx constants to represent media types.
940 * This list is used by File::isSafeFile
942 * Types not listed here will have a warning about unsafe content
943 * displayed on the images description page. It would also be possible
944 * to use this for further restrictions, like disabling direct
945 * [[media:...]] links for non-trusted formats.
947 $wgTrustedMediaFormats = [
948 MEDIATYPE_BITMAP
, // all bitmap formats
949 MEDIATYPE_AUDIO
, // all audio formats
950 MEDIATYPE_VIDEO
, // all plain video formats
951 "image/svg+xml", // svg (only needed if inline rendering of svg is not supported)
952 "application/pdf", // PDF files
953 # "application/x-shockwave-flash", //flash/shockwave movie
957 * Plugins for media file type handling.
958 * Each entry in the array maps a MIME type to a class name
960 * Core media handlers are listed in MediaHandlerFactory,
961 * and extensions should use extension.json.
963 $wgMediaHandlers = [];
966 * Media handler overrides for parser tests (they don't need to generate actual
967 * thumbnails, so a mock will do)
969 $wgParserTestMediaHandlers = [
970 'image/jpeg' => 'MockBitmapHandler',
971 'image/png' => 'MockBitmapHandler',
972 'image/gif' => 'MockBitmapHandler',
973 'image/tiff' => 'MockBitmapHandler',
974 'image/webp' => 'MockBitmapHandler',
975 'image/x-ms-bmp' => 'MockBitmapHandler',
976 'image/x-bmp' => 'MockBitmapHandler',
977 'image/x-xcf' => 'MockBitmapHandler',
978 'image/svg+xml' => 'MockSvgHandler',
979 'image/vnd.djvu' => 'MockDjVuHandler',
983 * Plugins for page content model handling.
984 * Each entry in the array maps a model id to a class name or callback
985 * that creates an instance of the appropriate ContentHandler subclass.
989 $wgContentHandlers = [
991 CONTENT_MODEL_WIKITEXT
=> WikitextContentHandler
::class,
992 // dumb version, no syntax highlighting
993 CONTENT_MODEL_JAVASCRIPT
=> JavaScriptContentHandler
::class,
994 // simple implementation, for use by extensions, etc.
995 CONTENT_MODEL_JSON
=> JsonContentHandler
::class,
996 // dumb version, no syntax highlighting
997 CONTENT_MODEL_CSS
=> CssContentHandler
::class,
998 // plain text, for use by extensions, etc.
999 CONTENT_MODEL_TEXT
=> TextContentHandler
::class,
1003 * Whether to enable server-side image thumbnailing. If false, images will
1004 * always be sent to the client in full resolution, with appropriate width= and
1005 * height= attributes on the <img> tag for the client to do its own scaling.
1007 $wgUseImageResize = true;
1010 * Resizing can be done using PHP's internal image libraries or using
1011 * ImageMagick or another third-party converter, e.g. GraphicMagick.
1012 * These support more file formats than PHP, which only supports PNG,
1013 * GIF, JPG, XBM and WBMP.
1015 * Use Image Magick instead of PHP builtin functions.
1017 $wgUseImageMagick = false;
1020 * The convert command shipped with ImageMagick
1022 $wgImageMagickConvertCommand = '/usr/bin/convert';
1025 * Array of max pixel areas for interlacing per MIME type
1028 $wgMaxInterlacingAreas = [];
1031 * Sharpening parameter to ImageMagick
1033 $wgSharpenParameter = '0x0.4';
1036 * Reduction in linear dimensions below which sharpening will be enabled
1038 $wgSharpenReductionThreshold = 0.85;
1041 * Temporary directory used for ImageMagick. The directory must exist. Leave
1042 * this set to false to let ImageMagick decide for itself.
1044 $wgImageMagickTempDir = false;
1047 * Use another resizing converter, e.g. GraphicMagick
1048 * %s will be replaced with the source path, %d with the destination
1049 * %w and %h will be replaced with the width and height.
1051 * @par Example for GraphicMagick:
1053 * $wgCustomConvertCommand = "gm convert %s -resize %wx%h %d"
1056 * Leave as false to skip this.
1058 $wgCustomConvertCommand = false;
1061 * used for lossless jpeg rotation
1065 $wgJpegTran = '/usr/bin/jpegtran';
1068 * At default setting of 'yuv420', JPEG thumbnails will use 4:2:0 chroma
1069 * subsampling to reduce file size, at the cost of possible color fringing
1072 * See https://en.wikipedia.org/wiki/Chroma_subsampling
1075 * false - use scaling system's default (same as pre-1.27 behavior)
1076 * 'yuv444' - luma and chroma at same resolution
1077 * 'yuv422' - chroma at 1/2 resolution horizontally, full vertically
1078 * 'yuv420' - chroma at 1/2 resolution in both dimensions
1080 * This setting is currently supported only for the ImageMagick backend;
1081 * others may default to 4:2:0 or 4:4:4 or maintaining the source file's
1082 * sampling in the thumbnail.
1086 $wgJpegPixelFormat = 'yuv420';
1089 * Some tests and extensions use exiv2 to manipulate the Exif metadata in some
1092 $wgExiv2Command = '/usr/bin/exiv2';
1095 * Path to exiftool binary. Used for lossless ICC profile swapping.
1099 $wgExiftool = '/usr/bin/exiftool';
1102 * Scalable Vector Graphics (SVG) may be uploaded as images.
1103 * Since SVG support is not yet standard in browsers, it is
1104 * necessary to rasterize SVGs to PNG as a fallback format.
1106 * An external program is required to perform this conversion.
1107 * If set to an array, the first item is a PHP callable and any further items
1108 * are passed as parameters after $srcPath, $dstPath, $width, $height
1110 $wgSVGConverters = [
1112 '$path/convert -background "#ffffff00" -thumbnail $widthx$height\! $input PNG:$output',
1113 'sodipodi' => '$path/sodipodi -z -w $width -f $input -e $output',
1114 'inkscape' => '$path/inkscape -z -w $width -f $input -e $output',
1115 'batik' => 'java -Djava.awt.headless=true -jar $path/batik-rasterizer.jar -w $width -d '
1117 'rsvg' => '$path/rsvg-convert -w $width -h $height -o $output $input',
1118 'imgserv' => '$path/imgserv-wrapper -i svg -o png -w$width $input $output',
1119 'ImagickExt' => [ 'SvgHandler::rasterizeImagickExt' ],
1123 * Pick a converter defined in $wgSVGConverters
1125 $wgSVGConverter = 'ImageMagick';
1128 * If not in the executable PATH, specify the SVG converter path.
1130 $wgSVGConverterPath = '';
1133 * Don't scale a SVG larger than this
1135 $wgSVGMaxSize = 5120;
1138 * Don't read SVG metadata beyond this point.
1139 * Default is 1024*256 bytes
1141 $wgSVGMetadataCutoff = 262144;
1144 * Disallow <title> element in SVG files.
1146 * MediaWiki will reject HTMLesque tags in uploaded files due to idiotic
1147 * browsers which can not perform basic stuff like MIME detection and which are
1148 * vulnerable to further idiots uploading crap files as images.
1150 * When this directive is on, "<title>" will be allowed in files with an
1151 * "image/svg+xml" MIME type. You should leave this disabled if your web server
1152 * is misconfigured and doesn't send appropriate MIME types for SVG images.
1154 $wgAllowTitlesInSVG = false;
1157 * The maximum number of pixels a source image can have if it is to be scaled
1158 * down by a scaler that requires the full source image to be decompressed
1159 * and stored in decompressed form, before the thumbnail is generated.
1161 * This provides a limit on memory usage for the decompression side of the
1162 * image scaler. The limit is used when scaling PNGs with any of the
1163 * built-in image scalers, such as ImageMagick or GD. It is ignored for
1164 * JPEGs with ImageMagick, and when using the VipsScaler extension.
1166 * The default is 50 MB if decompressed to RGBA form, which corresponds to
1167 * 12.5 million pixels or 3500x3500.
1169 $wgMaxImageArea = 1.25e7
;
1172 * Force thumbnailing of animated GIFs above this size to a single
1173 * frame instead of an animated thumbnail. As of MW 1.17 this limit
1174 * is checked against the total size of all frames in the animation.
1175 * It probably makes sense to keep this equal to $wgMaxImageArea.
1177 $wgMaxAnimatedGifArea = 1.25e7
;
1180 * Browsers don't support TIFF inline generally...
1181 * For inline display, we need to convert to PNG or JPEG.
1182 * Note scaling should work with ImageMagick, but may not with GD scaling.
1186 * // PNG is lossless, but inefficient for photos
1187 * $wgTiffThumbnailType = [ 'png', 'image/png' ];
1188 * // JPEG is good for photos, but has no transparency support. Bad for diagrams.
1189 * $wgTiffThumbnailType = [ 'jpg', 'image/jpeg' ];
1192 $wgTiffThumbnailType = false;
1195 * If rendered thumbnail files are older than this timestamp, they
1196 * will be rerendered on demand as if the file didn't already exist.
1197 * Update if there is some need to force thumbs and SVG rasterizations
1198 * to rerender, such as fixes to rendering bugs.
1200 $wgThumbnailEpoch = '20030516000000';
1203 * Certain operations are avoided if there were too many recent failures,
1204 * for example, thumbnail generation. Bump this value to invalidate all
1205 * memory of failed operations and thus allow further attempts to resume.
1206 * This is useful when a cause for the failures has been found and fixed.
1208 $wgAttemptFailureEpoch = 1;
1211 * If set, inline scaled images will still produce "<img>" tags ready for
1212 * output instead of showing an error message.
1214 * This may be useful if errors are transitory, especially if the site
1215 * is configured to automatically render thumbnails on request.
1217 * On the other hand, it may obscure error conditions from debugging.
1218 * Enable the debug log or the 'thumbnail' log group to make sure errors
1219 * are logged to a file for review.
1221 $wgIgnoreImageErrors = false;
1224 * Allow thumbnail rendering on page view. If this is false, a valid
1225 * thumbnail URL is still output, but no file will be created at
1226 * the target location. This may save some time if you have a
1227 * thumb.php or 404 handler set up which is faster than the regular
1230 $wgGenerateThumbnailOnParse = true;
1233 * Show thumbnails for old images on the image description page
1235 $wgShowArchiveThumbnails = true;
1238 * If set to true, images that contain certain the exif orientation tag will
1239 * be rotated accordingly. If set to null, try to auto-detect whether a scaler
1240 * is available that can rotate.
1242 $wgEnableAutoRotation = null;
1245 * Internal name of virus scanner. This serves as a key to the
1246 * $wgAntivirusSetup array. Set this to NULL to disable virus scanning. If not
1247 * null, every file uploaded will be scanned for viruses.
1249 $wgAntivirus = null;
1252 * Configuration for different virus scanners. This an associative array of
1253 * associative arrays. It contains one setup array per known scanner type.
1254 * The entry is selected by $wgAntivirus, i.e.
1255 * valid values for $wgAntivirus are the keys defined in this array.
1257 * The configuration array for each scanner contains the following keys:
1258 * "command", "codemap", "messagepattern":
1260 * "command" is the full command to call the virus scanner - %f will be
1261 * replaced with the name of the file to scan. If not present, the filename
1262 * will be appended to the command. Note that this must be overwritten if the
1263 * scanner is not in the system path; in that case, please set
1264 * $wgAntivirusSetup[$wgAntivirus]['command'] to the desired command with full
1267 * "codemap" is a mapping of exit code to return codes of the detectVirus
1268 * function in SpecialUpload.
1269 * - An exit code mapped to AV_SCAN_FAILED causes the function to consider
1270 * the scan to be failed. This will pass the file if $wgAntivirusRequired
1272 * - An exit code mapped to AV_SCAN_ABORTED causes the function to consider
1273 * the file to have an unsupported format, which is probably immune to
1274 * viruses. This causes the file to pass.
1275 * - An exit code mapped to AV_NO_VIRUS will cause the file to pass, meaning
1276 * no virus was found.
1277 * - All other codes (like AV_VIRUS_FOUND) will cause the function to report
1279 * - You may use "*" as a key in the array to catch all exit codes not mapped otherwise.
1281 * "messagepattern" is a perl regular expression to extract the meaningful part of the scanners
1282 * output. The relevant part should be matched as group one (\1).
1283 * If not defined or the pattern does not match, the full message is shown to the user.
1285 $wgAntivirusSetup = [
1289 'command' => 'clamscan --no-summary ',
1291 "0" => AV_NO_VIRUS
, # no virus
1292 "1" => AV_VIRUS_FOUND
, # virus found
1293 "52" => AV_SCAN_ABORTED
, # unsupported file format (probably immune)
1294 "*" => AV_SCAN_FAILED
, # else scan failed
1296 'messagepattern' => '/.*?:(.*)/sim',
1301 * Determines if a failed virus scan (AV_SCAN_FAILED) will cause the file to be rejected.
1303 $wgAntivirusRequired = true;
1306 * Determines if the MIME type of uploaded files should be checked
1308 $wgVerifyMimeType = true;
1311 * Sets the MIME type definition file to use by MimeMagic.php.
1312 * Set to null, to use built-in defaults only.
1313 * example: $wgMimeTypeFile = '/etc/mime.types';
1315 $wgMimeTypeFile = 'includes/mime.types';
1318 * Sets the MIME type info file to use by MimeMagic.php.
1319 * Set to null, to use built-in defaults only.
1321 $wgMimeInfoFile = 'includes/mime.info';
1324 * Sets an external MIME detector program. The command must print only
1325 * the MIME type to standard output.
1326 * The name of the file to process will be appended to the command given here.
1327 * If not set or NULL, PHP's mime_content_type function will be used.
1331 * #$wgMimeDetectorCommand = "file -bi"; # use external MIME detector (Linux)
1334 $wgMimeDetectorCommand = null;
1337 * Switch for trivial MIME detection. Used by thumb.php to disable all fancy
1338 * things, because only a few types of images are needed and file extensions
1341 $wgTrivialMimeDetection = false;
1344 * Additional XML types we can allow via MIME-detection.
1345 * array = [ 'rootElement' => 'associatedMimeType' ]
1348 'http://www.w3.org/2000/svg:svg' => 'image/svg+xml',
1349 'svg' => 'image/svg+xml',
1350 'http://www.lysator.liu.se/~alla/dia/:diagram' => 'application/x-dia-diagram',
1351 'http://www.w3.org/1999/xhtml:html' => 'text/html', // application/xhtml+xml?
1352 'html' => 'text/html', // application/xhtml+xml?
1356 * Limit images on image description pages to a user-selectable limit. In order
1357 * to reduce disk usage, limits can only be selected from a list.
1358 * The user preference is saved as an array offset in the database, by default
1359 * the offset is set with $wgDefaultUserOptions['imagesize']. Make sure you
1360 * change it if you alter the array (see T10858).
1361 * This is the list of settings the user can choose from:
1372 * Adjust thumbnails on image pages according to a user setting. In order to
1373 * reduce disk usage, the values can only be selected from a list. This is the
1374 * list of settings the user can choose from:
1386 * When defined, is an array of image widths used as buckets for thumbnail generation.
1387 * The goal is to save resources by generating thumbnails based on reference buckets instead of
1388 * always using the original. This will incur a speed gain but cause a quality loss.
1390 * The buckets generation is chained, with each bucket generated based on the above bucket
1391 * when possible. File handlers have to opt into using that feature. For now only BitmapHandler
1394 $wgThumbnailBuckets = null;
1397 * When using thumbnail buckets as defined above, this sets the minimum distance to the bucket
1398 * above the requested size. The distance represents how many extra pixels of width the bucket
1399 * needs in order to be used as the reference for a given thumbnail. For example, with the
1400 * following buckets:
1402 * $wgThumbnailBuckets = [ 128, 256, 512 ];
1404 * and a distance of 50:
1406 * $wgThumbnailMinimumBucketDistance = 50;
1408 * If we want to render a thumbnail of width 220px, the 512px bucket will be used,
1409 * because 220 + 50 = 270 and the closest bucket bigger than 270px is 512.
1411 $wgThumbnailMinimumBucketDistance = 50;
1414 * When defined, is an array of thumbnail widths to be rendered at upload time. The idea is to
1415 * prerender common thumbnail sizes, in order to avoid the necessity to render them on demand, which
1416 * has a performance impact for the first client to view a certain size.
1418 * This obviously means that more disk space is needed per upload upfront.
1423 $wgUploadThumbnailRenderMap = [];
1426 * The method through which the thumbnails will be prerendered for the entries in
1427 * $wgUploadThumbnailRenderMap
1429 * The method can be either "http" or "jobqueue". The former uses an http request to hit the
1431 * This method only works if thumbnails are configured to be rendered by a 404 handler. The latter
1432 * option uses the job queue to render the thumbnail.
1436 $wgUploadThumbnailRenderMethod = 'jobqueue';
1439 * When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom Host HTTP header.
1443 $wgUploadThumbnailRenderHttpCustomHost = false;
1446 * When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom domain to send the
1451 $wgUploadThumbnailRenderHttpCustomDomain = false;
1454 * When this variable is true and JPGs use the sRGB ICC profile, swaps it for the more lightweight
1455 * (and free) TinyRGB profile when generating thumbnails.
1459 $wgUseTinyRGBForJPGThumbnails = false;
1462 * Parameters for the "<gallery>" tag.
1464 * - imagesPerRow: Default number of images per-row in the gallery. 0 -> Adapt to screensize
1465 * - imageWidth: Width of the cells containing images in galleries (in "px")
1466 * - imageHeight: Height of the cells containing images in galleries (in "px")
1467 * - captionLength: Length to truncate filename to in caption when using "showfilename".
1468 * A value of 'true' will truncate the filename to one line using CSS
1469 * and will be the behaviour after deprecation.
1470 * @deprecated since 1.28
1471 * - showBytes: Show the filesize in bytes in categories
1472 * - showDimensions: Show the dimensions (width x height) in categories
1473 * - mode: Gallery mode
1475 $wgGalleryOptions = [];
1478 * Adjust width of upright images when parameter 'upright' is used
1479 * This allows a nicer look for upright images without the need to fix the width
1480 * by hardcoded px in wiki sourcecode.
1482 $wgThumbUpright = 0.75;
1485 * Default value for chmoding of new directories.
1487 $wgDirectoryMode = 0777;
1490 * Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities.
1492 * This means a 320x240 use of an image on the wiki will also generate 480x360 and 640x480
1493 * thumbnails, output via the srcset attribute.
1495 * On older browsers, a JavaScript polyfill switches the appropriate images in after loading
1496 * the original low-resolution versions depending on the reported window.devicePixelRatio.
1497 * The polyfill can be found in the jquery.hidpi module.
1499 $wgResponsiveImages = true;
1502 * @name DJVU settings
1507 * Path of the djvudump executable
1508 * Enable this and $wgDjvuRenderer to enable djvu rendering
1509 * example: $wgDjvuDump = 'djvudump';
1514 * Path of the ddjvu DJVU renderer
1515 * Enable this and $wgDjvuDump to enable djvu rendering
1516 * example: $wgDjvuRenderer = 'ddjvu';
1518 $wgDjvuRenderer = null;
1521 * Path of the djvutxt DJVU text extraction utility
1522 * Enable this and $wgDjvuDump to enable text layer extraction from djvu files
1523 * example: $wgDjvuTxt = 'djvutxt';
1528 * Path of the djvutoxml executable
1529 * This works like djvudump except much, much slower as of version 3.5.
1531 * For now we recommend you use djvudump instead. The djvuxml output is
1532 * probably more stable, so we'll switch back to it as soon as they fix
1533 * the efficiency problem.
1534 * https://sourceforge.net/tracker/index.php?func=detail&aid=1704049&group_id=32953&atid=406583
1538 * $wgDjvuToXML = 'djvutoxml';
1541 $wgDjvuToXML = null;
1544 * Shell command for the DJVU post processor
1545 * Default: pnmtojpeg, since ddjvu generates ppm output
1546 * Set this to false to output the ppm file directly.
1548 $wgDjvuPostProcessor = 'pnmtojpeg';
1551 * File extension for the DJVU post processor output
1553 $wgDjvuOutputExtension = 'jpg';
1555 /** @} */ # end of DJvu }
1557 /** @} */ # end of file uploads }
1559 /************************************************************************//**
1560 * @name Email settings
1565 * Site admin email address.
1567 * Defaults to "wikiadmin@$wgServerName".
1569 $wgEmergencyContact = false;
1572 * Sender email address for e-mail notifications.
1574 * The address we use as sender when a user requests a password reminder.
1576 * Defaults to "apache@$wgServerName".
1578 $wgPasswordSender = false;
1581 * Sender name for e-mail notifications.
1583 * @deprecated since 1.23; use the system message 'emailsender' instead.
1585 $wgPasswordSenderName = 'MediaWiki Mail';
1588 * Reply-To address for e-mail notifications.
1590 * Defaults to $wgPasswordSender.
1592 $wgNoReplyAddress = false;
1595 * Set to true to enable the e-mail basic features:
1596 * Password reminders, etc. If sending e-mail on your
1597 * server doesn't work, you might want to disable this.
1599 $wgEnableEmail = true;
1602 * Set to true to enable user-to-user e-mail.
1603 * This can potentially be abused, as it's hard to track.
1605 $wgEnableUserEmail = true;
1608 * Set to true to enable user-to-user e-mail blacklist.
1612 $wgEnableUserEmailBlacklist = false;
1615 * If true put the sending user's email in a Reply-To header
1616 * instead of From (false). ($wgPasswordSender will be used as From.)
1618 * Some mailers (eg SMTP) set the SMTP envelope sender to the From value,
1619 * which can cause problems with SPF validation and leak recipient addresses
1620 * when bounces are sent to the sender. In addition, DMARC restrictions
1621 * can cause emails to fail to be received when false.
1623 $wgUserEmailUseReplyTo = true;
1626 * Minimum time, in hours, which must elapse between password reminder
1627 * emails for a given account. This is to prevent abuse by mail flooding.
1629 $wgPasswordReminderResendTime = 24;
1632 * The time, in seconds, when an emailed temporary password expires.
1634 $wgNewPasswordExpiry = 3600 * 24 * 7;
1637 * The time, in seconds, when an email confirmation email expires
1639 $wgUserEmailConfirmationTokenExpiry = 7 * 24 * 60 * 60;
1642 * The number of days that a user's password is good for. After this number of days, the
1643 * user will be asked to reset their password. Set to false to disable password expiration.
1645 $wgPasswordExpirationDays = false;
1648 * If a user's password is expired, the number of seconds when they can still login,
1649 * and cancel their password change, but are sent to the password change form on each login.
1651 $wgPasswordExpireGrace = 3600 * 24 * 7; // 7 days
1656 * For using a direct (authenticated) SMTP server connection.
1657 * Default to false or fill an array :
1661 * 'host' => 'SMTP domain',
1662 * 'IDHost' => 'domain for MessageID',
1664 * 'auth' => [true|false],
1665 * 'username' => [SMTP username],
1666 * 'password' => [SMTP password],
1673 * Additional email parameters, will be passed as the last argument to mail() call.
1675 $wgAdditionalMailParams = null;
1678 * For parts of the system that have been updated to provide HTML email content, send
1679 * both text and HTML parts as the body of the email
1681 $wgAllowHTMLEmail = false;
1684 * True: from page editor if s/he opted-in. False: Enotif mails appear to come
1685 * from $wgEmergencyContact
1687 $wgEnotifFromEditor = false;
1689 // TODO move UPO to preferences probably ?
1690 # If set to true, users get a corresponding option in their preferences and can choose to
1691 # enable or disable at their discretion
1692 # If set to false, the corresponding input form on the user preference page is suppressed
1693 # It call this to be a "user-preferences-option (UPO)"
1696 * Require email authentication before sending mail to an email address.
1697 * This is highly recommended. It prevents MediaWiki from being used as an open
1700 $wgEmailAuthentication = true;
1703 * Allow users to enable email notification ("enotif") on watchlist changes.
1705 $wgEnotifWatchlist = false;
1708 * Allow users to enable email notification ("enotif") when someone edits their
1711 * The owner of the user talk page must also have the 'enotifusertalkpages' user
1712 * preference set to true.
1714 $wgEnotifUserTalk = false;
1717 * Set the Reply-to address in notifications to the editor's address, if user
1718 * allowed this in the preferences.
1720 $wgEnotifRevealEditorAddress = false;
1723 * Potentially send notification mails on minor edits to pages. This is enabled
1724 * by default. If this is false, users will never be notified on minor edits.
1726 * If it is true, editors with the 'nominornewtalk' right (typically bots) will still not
1727 * trigger notifications for minor edits they make (to any page, not just user talk).
1729 * Finally, if the watcher/recipient has the 'enotifminoredits' user preference set to
1730 * false, they will not receive notifications for minor edits.
1732 * User talk notifications are also affected by $wgEnotifMinorEdits, the above settings,
1733 * $wgEnotifUserTalk, and the preference described there.
1735 $wgEnotifMinorEdits = true;
1738 * Send a generic mail instead of a personalised mail for each user. This
1739 * always uses UTC as the time zone, and doesn't include the username.
1741 * For pages with many users watching, this can significantly reduce mail load.
1742 * Has no effect when using sendmail rather than SMTP.
1744 $wgEnotifImpersonal = false;
1747 * Maximum number of users to mail at once when using impersonal mail. Should
1748 * match the limit on your mail server.
1750 $wgEnotifMaxRecips = 500;
1753 * Use real name instead of username in e-mail "from" field.
1755 $wgEnotifUseRealName = false;
1758 * Array of usernames who will be sent a notification email for every change
1759 * which occurs on a wiki. Users will not be notified of their own changes.
1761 $wgUsersNotifiedOnAllChanges = [];
1763 /** @} */ # end of email settings
1765 /************************************************************************//**
1766 * @name Database settings
1771 * Database host name or IP address
1773 $wgDBserver = 'localhost';
1776 * Database port number (for PostgreSQL and Microsoft SQL Server).
1781 * Name of the database
1783 $wgDBname = 'my_wiki';
1788 $wgDBuser = 'wikiuser';
1791 * Database user's password
1798 $wgDBtype = 'mysql';
1801 * Whether to use SSL in DB connection.
1803 * This setting is only used if $wgLBFactoryConf['class'] is set to
1804 * '\Wikimedia\Rdbms\LBFactorySimple' and $wgDBservers is an empty array; otherwise
1805 * the DBO_SSL flag must be set in the 'flags' option of the database
1806 * connection to achieve the same functionality.
1811 * Whether to use compression in DB connection.
1813 * This setting is only used $wgLBFactoryConf['class'] is set to
1814 * '\Wikimedia\Rdbms\LBFactorySimple' and $wgDBservers is an empty array; otherwise
1815 * the DBO_COMPRESS flag must be set in the 'flags' option of the database
1816 * connection to achieve the same functionality.
1818 $wgDBcompress = false;
1821 * Separate username for maintenance tasks. Leave as null to use the default.
1823 $wgDBadminuser = null;
1826 * Separate password for maintenance tasks. Leave as null to use the default.
1828 $wgDBadminpassword = null;
1832 * Leave as null to select the default search engine for the
1833 * selected database type (eg SearchMySQL), or set to a class
1834 * name to override to a custom search engine.
1836 $wgSearchType = null;
1839 * Alternative search types
1840 * Sometimes you want to support multiple search engines for testing. This
1841 * allows users to select their search engine of choice via url parameters
1842 * to Special:Search and the action=search API. If using this, there's no
1843 * need to add $wgSearchType to it, that is handled automatically.
1845 $wgSearchTypeAlternatives = null;
1853 * MySQL table options to use during installation or update
1855 $wgDBTableOptions = 'ENGINE=InnoDB';
1858 * SQL Mode - default is turning off all modes, including strict, if set.
1859 * null can be used to skip the setting for performance reasons and assume
1860 * DBA has done his best job.
1861 * String override can be used for some additional fun :-)
1868 $wgDBmwschema = null;
1871 * To override default SQLite data directory ($docroot/../data)
1873 $wgSQLiteDataDir = '';
1876 * Shared database for multiple wikis. Commonly used for storing a user table
1877 * for single sign-on. The server for this database must be the same as for the
1880 * For backwards compatibility the shared prefix is set to the same as the local
1881 * prefix, and the user table is listed in the default list of shared tables.
1882 * The user_properties table is also added so that users will continue to have their
1883 * preferences shared (preferences were stored in the user table prior to 1.16)
1885 * $wgSharedTables may be customized with a list of tables to share in the shared
1886 * database. However it is advised to limit what tables you do share as many of
1887 * MediaWiki's tables may have side effects if you try to share them.
1889 * $wgSharedPrefix is the table prefix for the shared database. It defaults to
1892 * $wgSharedSchema is the table schema for the shared database. It defaults to
1895 * @deprecated since 1.21 In new code, use the $wiki parameter to wfGetLB() to
1896 * access remote databases. Using wfGetLB() allows the shared database to
1897 * reside on separate servers to the wiki's own database, with suitable
1898 * configuration of $wgLBFactoryConf.
1905 $wgSharedPrefix = false;
1910 $wgSharedTables = [ 'user', 'user_properties' ];
1916 $wgSharedSchema = false;
1919 * Database load balancer
1920 * This is a two-dimensional array, an array of server info structures
1923 * - dbname: Default database name
1925 * - password: DB password
1927 * - driver: DB driver (when there are multiple drivers)
1929 * - load: Ratio of DB_REPLICA load, must be >=0, the sum of all loads must be >0.
1930 * If this is zero for any given server, no normal query traffic will be
1931 * sent to it. It will be excluded from lag checks in maintenance scripts.
1932 * The only way it can receive traffic is if groupLoads is used.
1934 * - groupLoads: array of load ratios, the key is the query group name. A query may belong
1935 * to several groups, the most specific group defined here is used.
1937 * - flags: bit field
1938 * - DBO_DEFAULT -- turns on DBO_TRX only if "cliMode" is off (recommended)
1939 * - DBO_DEBUG -- equivalent of $wgDebugDumpSql
1940 * - DBO_TRX -- wrap entire request in a transaction
1941 * - DBO_NOBUFFER -- turn off buffering (not useful in LocalSettings.php)
1942 * - DBO_PERSISTENT -- enables persistent database connections
1943 * - DBO_SSL -- uses SSL/TLS encryption in database connections, if available
1944 * - DBO_COMPRESS -- uses internal compression in database connections,
1947 * - max lag: (optional) Maximum replication lag before a replica DB goes out of rotation
1948 * - is static: (optional) Set to true if the dataset is static and no replication is used.
1949 * - cliMode: (optional) Connection handles will not assume that requests are short-lived
1950 * nor that INSERT..SELECT can be rewritten into a buffered SELECT and INSERT.
1951 * [Default: uses value of $wgCommandLineMode]
1953 * These and any other user-defined properties will be assigned to the mLBInfo member
1954 * variable of the Database object.
1956 * Leave at false to use the single-server variables above. If you set this
1957 * variable, the single-server variables will generally be ignored (except
1958 * perhaps in some command-line scripts).
1960 * The first server listed in this array (with key 0) will be the master. The
1961 * rest of the servers will be replica DBs. To prevent writes to your replica DBs due to
1962 * accidental misconfiguration or MediaWiki bugs, set read_only=1 on all your
1963 * replica DBs in my.cnf. You can set read_only mode at runtime using:
1966 * SET @@read_only=1;
1969 * Since the effect of writing to a replica DB is so damaging and difficult to clean
1970 * up, we at Wikimedia set read_only=1 in my.cnf on all our DB servers, even
1971 * our masters, and then set read_only=0 on masters at runtime.
1973 $wgDBservers = false;
1976 * Load balancer factory configuration
1977 * To set up a multi-master wiki farm, set the class here to something that
1978 * can return a LoadBalancer with an appropriate master on a call to getMainLB().
1979 * The class identified here is responsible for reading $wgDBservers,
1980 * $wgDBserver, etc., so overriding it may cause those globals to be ignored.
1982 * The LBFactoryMulti class is provided for this purpose, please see
1983 * includes/db/LBFactoryMulti.php for configuration information.
1985 $wgLBFactoryConf = [ 'class' => \Wikimedia\Rdbms\LBFactorySimple
::class ];
1988 * After a state-changing request is done by a client, this determines
1989 * how many seconds that client should keep using the master datacenter.
1990 * This avoids unexpected stale or 404 responses due to replication lag.
1993 $wgDataCenterUpdateStickTTL = 10;
1996 * File to log database errors to
1998 $wgDBerrorLog = false;
2001 * Timezone to use in the error log.
2002 * Defaults to the wiki timezone ($wgLocaltimezone).
2004 * A list of usable timezones can found at:
2005 * https://secure.php.net/manual/en/timezones.php
2009 * $wgDBerrorLogTZ = 'UTC';
2010 * $wgDBerrorLogTZ = 'GMT';
2011 * $wgDBerrorLogTZ = 'PST8PDT';
2012 * $wgDBerrorLogTZ = 'Europe/Sweden';
2013 * $wgDBerrorLogTZ = 'CET';
2018 $wgDBerrorLogTZ = false;
2021 * Set to true to engage MySQL 4.1/5.0 charset-related features;
2022 * for now will just cause sending of 'SET NAMES=utf8' on connect.
2024 * @warning THIS IS EXPERIMENTAL!
2026 * May break if you're not using the table defs from mysql5/tables.sql.
2027 * May break if you're upgrading an existing wiki if set differently.
2028 * Broken symptoms likely to include incorrect behavior with page titles,
2029 * usernames, comments etc containing non-ASCII characters.
2030 * Might also cause failures on the object cache and other things.
2032 * Even correct usage may cause failures with Unicode supplementary
2033 * characters (those not in the Basic Multilingual Plane) unless MySQL
2034 * has enhanced their Unicode support.
2036 $wgDBmysql5 = false;
2039 * Set true to enable Oracle DCRP (supported from 11gR1 onward)
2041 * To use this feature set to true and use a datasource defined as
2042 * POOLED (i.e. in tnsnames definition set server=pooled in connect_data
2045 * Starting from 11gR1 you can use DCRP (Database Resident Connection
2046 * Pool) that maintains established sessions and reuses them on new
2049 * Not completely tested, but it should fall back on normal connection
2050 * in case the pool is full or the datasource is not configured as
2052 * And the other way around; using oci_pconnect on a non pooled
2053 * datasource should produce a normal connection.
2055 * When it comes to frequent shortlived DB connections like with MW
2056 * Oracle tends to s***. The problem is the driver connects to the
2057 * database reasonably fast, but establishing a session takes time and
2058 * resources. MW does not rely on session state (as it does not use
2059 * features such as package variables) so establishing a valid session
2060 * is in this case an unwanted overhead that just slows things down.
2062 * @warning EXPERIMENTAL!
2064 $wgDBOracleDRCP = false;
2067 * Other wikis on this site, can be administered from a single developer account.
2069 * Array numeric key => database name
2071 $wgLocalDatabases = [];
2074 * If lag is higher than $wgSlaveLagWarning, show a warning in some special
2075 * pages (like watchlist). If the lag is higher than $wgSlaveLagCritical,
2076 * show a more obvious warning.
2078 $wgSlaveLagWarning = 10;
2081 * @see $wgSlaveLagWarning
2083 $wgSlaveLagCritical = 30;
2086 * Use Windows Authentication instead of $wgDBuser / $wgDBpassword for MS SQL Server
2088 $wgDBWindowsAuthentication = false;
2090 /**@}*/ # End of DB settings }
2092 /************************************************************************//**
2093 * @name Text storage
2098 * We can also compress text stored in the 'text' table. If this is set on, new
2099 * revisions will be compressed on page save if zlib support is available. Any
2100 * compressed revisions will be decompressed on load regardless of this setting,
2101 * but will not be readable at all* if zlib support is not available.
2103 $wgCompressRevisions = false;
2106 * External stores allow including content
2107 * from non database sources following URL links.
2109 * Short names of ExternalStore classes may be specified in an array here:
2111 * $wgExternalStores = [ "http","file","custom" ]...
2114 * CAUTION: Access to database might lead to code execution
2116 $wgExternalStores = [];
2119 * An array of external MySQL servers.
2122 * Create a cluster named 'cluster1' containing three servers:
2124 * $wgExternalServers = [
2125 * 'cluster1' => <array in the same format as $wgDBservers>
2129 * Used by \Wikimedia\Rdbms\LBFactorySimple, may be ignored if $wgLBFactoryConf is set to
2132 $wgExternalServers = [];
2135 * The place to put new revisions, false to put them in the local text table.
2136 * Part of a URL, e.g. DB://cluster1
2138 * Can be an array instead of a single string, to enable data distribution. Keys
2139 * must be consecutive integers, starting at zero.
2143 * $wgDefaultExternalStore = [ 'DB://cluster1', 'DB://cluster2' ];
2148 $wgDefaultExternalStore = false;
2151 * Revision text may be cached in $wgMemc to reduce load on external storage
2152 * servers and object extraction overhead for frequently-loaded revisions.
2154 * Set to 0 to disable, or number of seconds before cache expiry.
2156 $wgRevisionCacheExpiry = 86400 * 7;
2158 /** @} */ # end text storage }
2160 /************************************************************************//**
2161 * @name Performance hacks and limits
2166 * Disable database-intensive features
2168 $wgMiserMode = false;
2171 * Disable all query pages if miser mode is on, not just some
2173 $wgDisableQueryPages = false;
2176 * Number of rows to cache in 'querycache' table when miser mode is on
2178 $wgQueryCacheLimit = 1000;
2181 * Number of links to a page required before it is deemed "wanted"
2183 $wgWantedPagesThreshold = 1;
2186 * Enable slow parser functions
2188 $wgAllowSlowParserFunctions = false;
2191 * Allow schema updates
2193 $wgAllowSchemaUpdates = true;
2196 * Maximum article size in kilobytes
2198 $wgMaxArticleSize = 2048;
2201 * The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to
2202 * raise PHP's memory limit if it's below this amount.
2204 $wgMemoryLimit = "50M";
2207 * The minimum amount of time that MediaWiki needs for "slow" write request,
2208 * particularly ones with multiple non-atomic writes that *should* be as
2209 * transactional as possible; MediaWiki will call set_time_limit() if needed.
2212 $wgTransactionalTimeLimit = 120;
2214 /** @} */ # end performance hacks }
2216 /************************************************************************//**
2217 * @name Cache settings
2222 * Directory for caching data in the local filesystem. Should not be accessible
2225 * Note: if multiple wikis share the same localisation cache directory, they
2226 * must all have the same set of extensions. You can set a directory just for
2227 * the localisation cache using $wgLocalisationCacheConf['storeDirectory'].
2229 $wgCacheDirectory = false;
2232 * Main cache type. This should be a cache with fast access, but it may have
2233 * limited space. By default, it is disabled, since the stock database cache
2234 * is not fast enough to make it worthwhile.
2238 * - CACHE_ANYTHING: Use anything, as long as it works
2239 * - CACHE_NONE: Do not cache
2240 * - CACHE_DB: Store cache objects in the DB
2241 * - CACHE_MEMCACHED: MemCached, must specify servers in $wgMemCachedServers
2242 * - CACHE_ACCEL: APC, APCU or WinCache
2243 * - (other): A string may be used which identifies a cache
2244 * configuration in $wgObjectCaches.
2246 * @see $wgMessageCacheType, $wgParserCacheType
2248 $wgMainCacheType = CACHE_NONE
;
2251 * The cache type for storing the contents of the MediaWiki namespace. This
2252 * cache is used for a small amount of data which is expensive to regenerate.
2254 * For available types see $wgMainCacheType.
2256 $wgMessageCacheType = CACHE_ANYTHING
;
2259 * The cache type for storing article HTML. This is used to store data which
2260 * is expensive to regenerate, and benefits from having plenty of storage space.
2262 * For available types see $wgMainCacheType.
2264 $wgParserCacheType = CACHE_ANYTHING
;
2267 * The cache type for storing session data.
2269 * For available types see $wgMainCacheType.
2271 $wgSessionCacheType = CACHE_ANYTHING
;
2274 * The cache type for storing language conversion tables,
2275 * which are used when parsing certain text and interface messages.
2277 * For available types see $wgMainCacheType.
2281 $wgLanguageConverterCacheType = CACHE_ANYTHING
;
2284 * Advanced object cache configuration.
2286 * Use this to define the class names and constructor parameters which are used
2287 * for the various cache types. Custom cache types may be defined here and
2288 * referenced from $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType,
2289 * or $wgLanguageConverterCacheType.
2291 * The format is an associative array where the key is a cache identifier, and
2292 * the value is an associative array of parameters. The "class" parameter is the
2293 * class name which will be used. Alternatively, a "factory" parameter may be
2294 * given, giving a callable function which will generate a suitable cache object.
2297 CACHE_NONE
=> [ 'class' => EmptyBagOStuff
::class, 'reportDupes' => false ],
2298 CACHE_DB
=> [ 'class' => SqlBagOStuff
::class, 'loggroup' => 'SQLBagOStuff' ],
2300 CACHE_ANYTHING
=> [ 'factory' => 'ObjectCache::newAnything' ],
2301 CACHE_ACCEL
=> [ 'factory' => 'ObjectCache::getLocalServerInstance' ],
2302 CACHE_MEMCACHED
=> [ 'class' => MemcachedPhpBagOStuff
::class, 'loggroup' => 'memcached' ],
2304 'db-replicated' => [
2305 'class' => ReplicatedBagOStuff
::class,
2307 'class' => SqlBagOStuff
::class,
2308 'args' => [ [ 'slaveOnly' => true ] ]
2311 'class' => SqlBagOStuff
::class,
2312 'args' => [ [ 'slaveOnly' => false ] ]
2314 'loggroup' => 'SQLBagOStuff',
2315 'reportDupes' => false
2318 'apc' => [ 'class' => APCBagOStuff
::class, 'reportDupes' => false ],
2319 'apcu' => [ 'class' => APCUBagOStuff
::class, 'reportDupes' => false ],
2320 'wincache' => [ 'class' => WinCacheBagOStuff
::class, 'reportDupes' => false ],
2321 'memcached-php' => [ 'class' => MemcachedPhpBagOStuff
::class, 'loggroup' => 'memcached' ],
2322 'memcached-pecl' => [ 'class' => MemcachedPeclBagOStuff
::class, 'loggroup' => 'memcached' ],
2323 'hash' => [ 'class' => HashBagOStuff
::class, 'reportDupes' => false ],
2327 * Main Wide-Area-Network cache type. This should be a cache with fast access,
2328 * but it may have limited space. By default, it is disabled, since the basic stock
2329 * cache is not fast enough to make it worthwhile. For single data-center setups, this can
2330 * simply be pointed to a cache in $wgWANObjectCaches that uses a local $wgObjectCaches
2331 * cache with a relayer of type EventRelayerNull.
2334 * - false: Configure the cache using $wgMainCacheType, without using
2335 * a relayer (only matters if there are multiple data-centers)
2336 * - CACHE_NONE: Do not cache
2337 * - (other): A string may be used which identifies a cache
2338 * configuration in $wgWANObjectCaches
2341 $wgMainWANCache = false;
2344 * Advanced WAN object cache configuration.
2346 * Each WAN cache wraps a registered object cache (for the local cluster)
2347 * and it must also be configured to point to a PubSub instance. Subscribers
2348 * must be configured to relay purges to the actual cache servers.
2350 * The format is an associative array where the key is a cache identifier, and
2351 * the value is an associative array of parameters. The "cacheId" parameter is
2352 * a cache identifier from $wgObjectCaches. The "channels" parameter is a map of
2353 * actions ('purge') to PubSub channels defined in $wgEventRelayerConfig.
2354 * The "loggroup" parameter controls where log events are sent.
2358 $wgWANObjectCaches = [
2360 'class' => WANObjectCache
::class,
2361 'cacheId' => CACHE_NONE
,
2364 /* Example of a simple single data-center cache:
2365 'memcached-php' => [
2366 'class' => WANObjectCache::class,
2367 'cacheId' => 'memcached-php',
2368 'channels' => [ 'purge' => 'wancache-main-memcached-purge' ]
2374 * Verify and enforce WAN cache purges using reliable DB sources as streams.
2376 * These secondary cache purges are de-duplicated via simple cache mutexes.
2377 * This improves consistency when cache purges are lost, which becomes more likely
2378 * as more cache servers are added or if there are multiple datacenters. Only keys
2379 * related to important mutable content will be checked.
2384 $wgEnableWANCacheReaper = false;
2387 * Main object stash type. This should be a fast storage system for storing
2388 * lightweight data like hit counters and user activity. Sites with multiple
2389 * data-centers should have this use a store that replicates all writes. The
2390 * store should have enough consistency for CAS operations to be usable.
2391 * Reads outside of those needed for merge() may be eventually consistent.
2394 * - db: Store cache objects in the DB
2395 * - (other): A string may be used which identifies a cache
2396 * configuration in $wgObjectCaches
2400 $wgMainStash = 'db-replicated';
2403 * The expiry time for the parser cache, in seconds.
2404 * The default is 86400 (one day).
2406 $wgParserCacheExpireTime = 86400;
2409 * @deprecated since 1.27, session data is always stored in object cache.
2411 $wgSessionsInObjectCache = true;
2414 * The expiry time to use for session storage, in seconds.
2416 $wgObjectCacheSessionExpiry = 3600;
2419 * @deprecated since 1.27, MediaWiki\Session\SessionManager doesn't use PHP session storage.
2421 $wgSessionHandler = null;
2424 * Whether to use PHP session handling ($_SESSION and session_*() functions)
2426 * If the constant MW_NO_SESSION is defined, this is forced to 'disable'.
2428 * If the constant MW_NO_SESSION_HANDLER is defined, this is ignored and PHP
2429 * session handling will function independently of SessionHandler.
2430 * SessionHandler and PHP's session handling may attempt to override each
2435 * - 'enable': Integrate with PHP's session handling as much as possible.
2436 * - 'warn': Integrate but log warnings if anything changes $_SESSION.
2437 * - 'disable': Throw exceptions if PHP session handling is used.
2439 $wgPHPSessionHandling = 'enable';
2442 * Number of internal PBKDF2 iterations to use when deriving session secrets.
2446 $wgSessionPbkdf2Iterations = 10001;
2449 * If enabled, will send MemCached debugging information to $wgDebugLogFile
2451 $wgMemCachedDebug = false;
2454 * The list of MemCached servers and port numbers
2456 $wgMemCachedServers = [ '127.0.0.1:11211' ];
2459 * Use persistent connections to MemCached, which are shared across multiple
2462 $wgMemCachedPersistent = false;
2465 * Read/write timeout for MemCached server communication, in microseconds.
2467 $wgMemCachedTimeout = 500000;
2470 * Set this to true to maintain a copy of the message cache on the local server.
2472 * This layer of message cache is in addition to the one configured by $wgMessageCacheType.
2474 * The local copy is put in APC. If APC is not installed, this setting does nothing.
2476 * Note that this is about the message cache, which stores interface messages
2477 * maintained as wiki pages. This is separate from the localisation cache for interface
2478 * messages provided by the software, which is configured by $wgLocalisationCacheConf.
2480 $wgUseLocalMessageCache = false;
2483 * Instead of caching everything, only cache those messages which have
2484 * been customised in the site content language. This means that
2485 * MediaWiki:Foo/ja is ignored if MediaWiki:Foo doesn't exist.
2486 * This option is probably only useful for translatewiki.net.
2488 $wgAdaptiveMessageCache = false;
2491 * Localisation cache configuration. Associative array with keys:
2492 * class: The class to use. May be overridden by extensions.
2494 * store: The location to store cache data. May be 'files', 'array', 'db' or
2495 * 'detect'. If set to "files", data will be in CDB files. If set
2496 * to "db", data will be stored to the database. If set to
2497 * "detect", files will be used if $wgCacheDirectory is set,
2498 * otherwise the database will be used.
2499 * "array" is an experimental option that uses PHP files that
2500 * store static arrays.
2502 * storeClass: The class name for the underlying storage. If set to a class
2503 * name, it overrides the "store" setting.
2505 * storeDirectory: If the store class puts its data in files, this is the
2506 * directory it will use. If this is false, $wgCacheDirectory
2509 * manualRecache: Set this to true to disable cache updates on web requests.
2510 * Use maintenance/rebuildLocalisationCache.php instead.
2512 $wgLocalisationCacheConf = [
2513 'class' => LocalisationCache
::class,
2514 'store' => 'detect',
2515 'storeClass' => false,
2516 'storeDirectory' => false,
2517 'manualRecache' => false,
2521 * Allow client-side caching of pages
2523 $wgCachePages = true;
2526 * Set this to current time to invalidate all prior cached pages. Affects both
2527 * client-side and server-side caching.
2528 * You can get the current date on your server by using the command:
2530 * date +%Y%m%d%H%M%S
2533 $wgCacheEpoch = '20030516000000';
2536 * Directory where GitInfo will look for pre-computed cache files. If false,
2537 * $wgCacheDirectory/gitinfo will be used.
2539 $wgGitInfoCacheDirectory = false;
2542 * Bump this number when changing the global style sheets and JavaScript.
2544 * It should be appended in the query string of static CSS and JS includes,
2545 * to ensure that client-side caches do not keep obsolete copies of global
2548 * @deprecated since 1.31
2550 $wgStyleVersion = '303';
2553 * This will cache static pages for non-logged-in users to reduce
2554 * database traffic on public sites. ResourceLoader requests to default
2555 * language and skins are cached as well as single module requests.
2557 $wgUseFileCache = false;
2560 * Depth of the subdirectory hierarchy to be created under
2561 * $wgFileCacheDirectory. The subdirectories will be named based on
2562 * the MD5 hash of the title. A value of 0 means all cache files will
2563 * be put directly into the main file cache directory.
2565 $wgFileCacheDepth = 2;
2568 * Kept for extension compatibility; see $wgParserCacheType
2569 * @deprecated since 1.26
2571 $wgEnableParserCache = true;
2574 * Append a configured value to the parser cache and the sitenotice key so
2575 * that they can be kept separate for some class of activity.
2577 $wgRenderHashAppend = '';
2580 * If on, the sidebar navigation links are cached for users with the
2581 * current language set. This can save a touch of load on a busy site
2582 * by shaving off extra message lookups.
2584 * However it is also fragile: changing the site configuration, or
2585 * having a variable $wgArticlePath, can produce broken links that
2586 * don't update as expected.
2588 $wgEnableSidebarCache = false;
2591 * Expiry time for the sidebar cache, in seconds
2593 $wgSidebarCacheExpiry = 86400;
2596 * When using the file cache, we can store the cached HTML gzipped to save disk
2597 * space. Pages will then also be served compressed to clients that support it.
2599 * Requires zlib support enabled in PHP.
2604 * Clock skew or the one-second resolution of time() can occasionally cause cache
2605 * problems when the user requests two pages within a short period of time. This
2606 * variable adds a given number of seconds to vulnerable timestamps, thereby giving
2609 $wgClockSkewFudge = 5;
2612 * Invalidate various caches when LocalSettings.php changes. This is equivalent
2613 * to setting $wgCacheEpoch to the modification time of LocalSettings.php, as
2614 * was previously done in the default LocalSettings.php file.
2616 * On high-traffic wikis, this should be set to false, to avoid the need to
2617 * check the file modification time, and to avoid the performance impact of
2618 * unnecessary cache invalidations.
2620 $wgInvalidateCacheOnLocalSettingsChange = true;
2623 * When loading extensions through the extension registration system, this
2624 * can be used to invalidate the cache. A good idea would be to set this to
2625 * one file, you can just `touch` that one to invalidate the cache
2629 * $wgExtensionInfoMtime = filemtime( "$IP/LocalSettings.php" );
2632 * If set to false, the mtime for each individual JSON file will be checked,
2633 * which can be slow if a large number of extensions are being loaded.
2637 $wgExtensionInfoMTime = false;
2639 /** @} */ # end of cache settings
2641 /************************************************************************//**
2642 * @name HTTP proxy (CDN) settings
2644 * Many of these settings apply to any HTTP proxy used in front of MediaWiki,
2645 * although they are referred to as Squid settings for historical reasons.
2647 * Achieving a high hit ratio with an HTTP proxy requires special
2648 * configuration. See https://www.mediawiki.org/wiki/Manual:Squid_caching for
2655 * Enable/disable CDN.
2656 * See https://www.mediawiki.org/wiki/Manual:Squid_caching
2658 $wgUseSquid = false;
2661 * If you run Squid3 with ESI support, enable this (default:false):
2666 * Send the Key HTTP header for better caching.
2667 * See https://datatracker.ietf.org/doc/draft-fielding-http-key/ for details.
2670 $wgUseKeyHeader = false;
2673 * Add X-Forwarded-Proto to the Vary and Key headers for API requests and
2674 * RSS/Atom feeds. Use this if you have an SSL termination setup
2675 * and need to split the cache between HTTP and HTTPS for API requests,
2676 * feed requests and HTTP redirect responses in order to prevent cache
2677 * pollution. This does not affect 'normal' requests to index.php other than
2680 $wgVaryOnXFP = false;
2683 * Internal server name as known to CDN, if different.
2687 * $wgInternalServer = 'http://yourinternal.tld:8000';
2690 $wgInternalServer = false;
2693 * Cache TTL for the CDN sent as s-maxage (without ESI) or
2694 * Surrogate-Control (with ESI). Without ESI, you should strip
2695 * out s-maxage in the CDN config.
2697 * 18000 seconds = 5 hours, more cache hits with 2678400 = 31 days.
2699 $wgSquidMaxage = 18000;
2702 * Cache timeout for the CDN when DB replica DB lag is high
2703 * @see $wgSquidMaxage
2706 $wgCdnMaxageLagged = 30;
2709 * If set, any SquidPurge call on a URL or URLs will send a second purge no less than
2710 * this many seconds later via the job queue. This requires delayed job support.
2711 * This should be safely higher than the 'max lag' value in $wgLBFactoryConf, so that
2712 * replica DB lag does not cause page to be stuck in stales states in CDN.
2714 * This also fixes race conditions in two-tiered CDN setups (e.g. cdn2 => cdn1 => MediaWiki).
2715 * If a purge for a URL reaches cdn2 before cdn1 and a request reaches cdn2 for that URL,
2716 * it will populate the response from the stale cdn1 value. When cdn1 gets the purge, cdn2
2717 * will still be stale. If the rebound purge delay is safely higher than the time to relay
2718 * a purge to all nodes, then the rebound puge will clear cdn2 after cdn1 was cleared.
2722 $wgCdnReboundPurgeDelay = 0;
2725 * Cache timeout for the CDN when a response is known to be wrong or incomplete (due to load)
2726 * @see $wgSquidMaxage
2729 $wgCdnMaxageSubstitute = 60;
2732 * Default maximum age for raw CSS/JS accesses
2734 * 300 seconds = 5 minutes.
2736 $wgForcedRawSMaxage = 300;
2739 * List of proxy servers to purge on changes; default port is 80. Use IP addresses.
2741 * When MediaWiki is running behind a proxy, it will trust X-Forwarded-For
2742 * headers sent/modified from these proxies when obtaining the remote IP address
2744 * For a list of trusted servers which *aren't* purged, see $wgSquidServersNoPurge.
2746 $wgSquidServers = [];
2749 * As above, except these servers aren't purged on page changes; use to set a
2750 * list of trusted proxies, etc. Supports both individual IP addresses and
2752 * @since 1.23 Supports CIDR ranges
2754 $wgSquidServersNoPurge = [];
2757 * Whether to use a Host header in purge requests sent to the proxy servers
2758 * configured in $wgSquidServers. Set this to false to support Squid
2759 * configured in forward-proxy mode.
2761 * If this is set to true, a Host header will be sent, and only the path
2762 * component of the URL will appear on the request line, as if the request
2763 * were a non-proxy HTTP 1.1 request. Varnish only supports this style of
2764 * request. Squid supports this style of request only if reverse-proxy mode
2765 * (http_port ... accel) is enabled.
2767 * If this is set to false, no Host header will be sent, and the absolute URL
2768 * will be sent in the request line, as is the standard for an HTTP proxy
2769 * request in both HTTP 1.0 and 1.1. This style of request is not supported
2770 * by Varnish, but is supported by Squid in either configuration (forward or
2775 $wgSquidPurgeUseHostHeader = true;
2778 * Routing configuration for HTCP multicast purging. Add elements here to
2779 * enable HTCP and determine which purges are sent where. If set to an empty
2780 * array, HTCP is disabled.
2782 * Each key in this array is a regular expression to match against the purged
2783 * URL, or an empty string to match all URLs. The purged URL is matched against
2784 * the regexes in the order specified, and the first rule whose regex matches
2785 * is used, all remaining rules will thus be ignored.
2787 * @par Example configuration to send purges for upload.wikimedia.org to one
2788 * multicast group and all other purges to another:
2790 * $wgHTCPRouting = [
2791 * '|^https?://upload\.wikimedia\.org|' => [
2792 * 'host' => '239.128.0.113',
2796 * 'host' => '239.128.0.112',
2802 * You can also pass an array of hosts to send purges too. This is useful when
2803 * you have several multicast groups or unicast address that should receive a
2804 * given purge. Multiple hosts support was introduced in MediaWiki 1.22.
2806 * @par Example of sending purges to multiple hosts:
2808 * $wgHTCPRouting = [
2810 * // Purges to text caches using multicast
2811 * [ 'host' => '239.128.0.114', 'port' => '4827' ],
2812 * // Purges to a hardcoded list of caches
2813 * [ 'host' => '10.88.66.1', 'port' => '4827' ],
2814 * [ 'host' => '10.88.66.2', 'port' => '4827' ],
2815 * [ 'host' => '10.88.66.3', 'port' => '4827' ],
2822 * $wgHTCPRouting replaces $wgHTCPMulticastRouting that was introduced in 1.20.
2823 * For back compatibility purposes, whenever its array is empty
2824 * $wgHTCPMutlicastRouting will be used as a fallback if it not null.
2826 * @see $wgHTCPMulticastTTL
2828 $wgHTCPRouting = [];
2831 * HTCP multicast TTL.
2832 * @see $wgHTCPRouting
2834 $wgHTCPMulticastTTL = 1;
2837 * Should forwarded Private IPs be accepted?
2839 $wgUsePrivateIPs = false;
2841 /** @} */ # end of HTTP proxy settings
2843 /************************************************************************//**
2844 * @name Language, regional and character encoding settings
2849 * Site language code. See languages/data/Names.php for languages supported by
2850 * MediaWiki out of the box. Not all languages listed there have translations,
2851 * see languages/messages/ for the list of languages with some localisation.
2853 * Warning: Don't use any of MediaWiki's deprecated language codes listed in
2854 * LanguageCode::getDeprecatedCodeMapping or $wgDummyLanguageCodes, like "no"
2855 * for Norwegian (use "nb" instead). If you do, things will break unexpectedly.
2857 * This defines the default interface language for all users, but users can
2858 * change it in their preferences.
2860 * This also defines the language of pages in the wiki. The content is wrapped
2861 * in a html element with lang=XX attribute. This behavior can be overridden
2862 * via hooks, see Title::getPageLanguage.
2864 $wgLanguageCode = 'en';
2867 * Language cache size, or really how many languages can we handle
2868 * simultaneously without degrading to crawl speed.
2870 $wgLangObjCacheSize = 10;
2873 * Some languages need different word forms, usually for different cases.
2874 * Used in Language::convertGrammar().
2878 * $wgGrammarForms['en']['genitive']['car'] = 'car\'s';
2881 $wgGrammarForms = [];
2884 * Treat language links as magic connectors, not inline links
2886 $wgInterwikiMagic = true;
2889 * Hide interlanguage links from the sidebar
2891 $wgHideInterlanguageLinks = false;
2894 * List of additional interwiki prefixes that should be treated as
2895 * interlanguage links (i.e. placed in the sidebar).
2897 * - This will not do anything unless the prefixes are defined in the interwiki
2899 * - The display text for these custom interlanguage links will be fetched from
2900 * the system message "interlanguage-link-xyz" where xyz is the prefix in
2902 * - A friendly name for each site, used for tooltip text, may optionally be
2903 * placed in the system message "interlanguage-link-sitename-xyz" where xyz is
2904 * the prefix in this array.
2906 $wgExtraInterlanguageLinkPrefixes = [];
2909 * List of language names or overrides for default names in Names.php
2911 $wgExtraLanguageNames = [];
2914 * List of mappings from one language code to another.
2915 * This array makes the codes not appear as a selectable language on the
2916 * installer, and excludes them when running the transstat.php script.
2918 * In Setup.php, the variable $wgDummyLanguageCodes is created by combining
2919 * these codes with a list of "deprecated" codes, which are mostly leftovers
2920 * from renames or other legacy things, and the internal codes 'qqq' and 'qqx'.
2921 * If a mapping in $wgExtraLanguageCodes collide with a built-in mapping, the
2922 * value in $wgExtraLanguageCodes will be used.
2926 $wgExtraLanguageCodes = [
2927 'bh' => 'bho', // Bihari language family
2928 'no' => 'nb', // Norwegian language family
2929 'simple' => 'en', // Simple English
2933 * Functionally the same as $wgExtraLanguageCodes, but deprecated. Instead of
2934 * appending values to this array, append them to $wgExtraLanguageCodes.
2936 * @deprecated since 1.29
2938 $wgDummyLanguageCodes = [];
2941 * Set this to true to replace Arabic presentation forms with their standard
2942 * forms in the U+0600-U+06FF block. This only works if $wgLanguageCode is
2945 * Note that pages with titles containing presentation forms will become
2946 * inaccessible, run maintenance/cleanupTitles.php to fix this.
2948 $wgFixArabicUnicode = true;
2951 * Set this to true to replace ZWJ-based chillu sequences in Malayalam text
2952 * with their Unicode 5.1 equivalents. This only works if $wgLanguageCode is
2953 * set to "ml". Note that some clients (even new clients as of 2010) do not
2954 * support these characters.
2956 * If you enable this on an existing wiki, run maintenance/cleanupTitles.php to
2957 * fix any ZWJ sequences in existing page titles.
2959 $wgFixMalayalamUnicode = true;
2962 * Set this to always convert certain Unicode sequences to modern ones
2963 * regardless of the content language. This has a small performance
2966 * See $wgFixArabicUnicode and $wgFixMalayalamUnicode for conversion
2971 $wgAllUnicodeFixes = false;
2974 * Set this to eg 'ISO-8859-1' to perform character set conversion when
2975 * loading old revisions not marked with "utf-8" flag. Use this when
2976 * converting a wiki from MediaWiki 1.4 or earlier to UTF-8 without the
2977 * burdensome mass conversion of old text data.
2979 * @note This DOES NOT touch any fields other than old_text. Titles, comments,
2980 * user names, etc still must be converted en masse in the database before
2981 * continuing as a UTF-8 wiki.
2983 $wgLegacyEncoding = false;
2986 * @deprecated since 1.30, does nothing
2988 $wgBrowserBlackList = [];
2991 * If set to true, the MediaWiki 1.4 to 1.5 schema conversion will
2992 * create stub reference rows in the text table instead of copying
2993 * the full text of all current entries from 'cur' to 'text'.
2995 * This will speed up the conversion step for large sites, but
2996 * requires that the cur table be kept around for those revisions
2997 * to remain viewable.
2999 * This option affects the updaters *only*. Any present cur stub
3000 * revisions will be readable at runtime regardless of this setting.
3002 $wgLegacySchemaConversion = false;
3005 * Enable dates like 'May 12' instead of '12 May', if the default date format
3008 $wgAmericanDates = false;
3011 * For Hindi and Arabic use local numerals instead of Western style (0-9)
3012 * numerals in interface.
3014 $wgTranslateNumerals = true;
3017 * Translation using MediaWiki: namespace.
3018 * Interface messages will be loaded from the database.
3020 $wgUseDatabaseMessages = true;
3023 * Expiry time for the message cache key
3025 $wgMsgCacheExpiry = 86400;
3028 * Maximum entry size in the message cache, in bytes
3030 $wgMaxMsgCacheEntrySize = 10000;
3033 * Whether to enable language variant conversion.
3035 $wgDisableLangConversion = false;
3038 * Whether to enable language variant conversion for links.
3040 $wgDisableTitleConversion = false;
3043 * Default variant code, if false, the default will be the language code
3045 $wgDefaultLanguageVariant = false;
3048 * Whether to enable the pig latin variant of English (en-x-piglatin),
3049 * used to ease variant development work.
3051 $wgUsePigLatinVariant = false;
3054 * Disabled variants array of language variant conversion.
3058 * $wgDisabledVariants[] = 'zh-mo';
3059 * $wgDisabledVariants[] = 'zh-my';
3062 $wgDisabledVariants = [];
3065 * Like $wgArticlePath, but on multi-variant wikis, this provides a
3066 * path format that describes which parts of the URL contain the
3071 * $wgLanguageCode = 'sr';
3072 * $wgVariantArticlePath = '/$2/$1';
3073 * $wgArticlePath = '/wiki/$1';
3076 * A link to /wiki/ would be redirected to /sr/Главна_страна
3078 * It is important that $wgArticlePath not overlap with possible values
3079 * of $wgVariantArticlePath.
3081 $wgVariantArticlePath = false;
3084 * Show a bar of language selection links in the user login and user
3085 * registration forms; edit the "loginlanguagelinks" message to
3088 $wgLoginLanguageSelector = false;
3091 * When translating messages with wfMessage(), it is not always clear what
3092 * should be considered UI messages and what should be content messages.
3094 * For example, for the English Wikipedia, there should be only one 'mainpage',
3095 * so when getting the link for 'mainpage', we should treat it as site content
3096 * and call ->inContentLanguage()->text(), but for rendering the text of the
3097 * link, we call ->text(). The code behaves this way by default. However,
3098 * sites like the Wikimedia Commons do offer different versions of 'mainpage'
3099 * and the like for different languages. This array provides a way to override
3100 * the default behavior.
3103 * To allow language-specific main page and community
3106 * $wgForceUIMsgAsContentMsg = [ 'mainpage', 'portal-url' ];
3109 $wgForceUIMsgAsContentMsg = [];
3112 * Fake out the timezone that the server thinks it's in. This will be used for
3113 * date display and not for what's stored in the DB. Leave to null to retain
3114 * your server's OS-based timezone value.
3116 * This variable is currently used only for signature formatting and for local
3117 * time/date parser variables ({{LOCALTIME}} etc.)
3119 * Timezones can be translated by editing MediaWiki messages of type
3120 * timezone-nameinlowercase like timezone-utc.
3122 * A list of usable timezones can found at:
3123 * https://secure.php.net/manual/en/timezones.php
3127 * $wgLocaltimezone = 'UTC';
3128 * $wgLocaltimezone = 'GMT';
3129 * $wgLocaltimezone = 'PST8PDT';
3130 * $wgLocaltimezone = 'Europe/Sweden';
3131 * $wgLocaltimezone = 'CET';
3134 $wgLocaltimezone = null;
3137 * Set an offset from UTC in minutes to use for the default timezone setting
3138 * for anonymous users and new user accounts.
3140 * This setting is used for most date/time displays in the software, and is
3141 * overridable in user preferences. It is *not* used for signature timestamps.
3143 * By default, this will be set to match $wgLocaltimezone.
3145 $wgLocalTZoffset = null;
3147 /** @} */ # End of language/charset settings
3149 /*************************************************************************//**
3150 * @name Output format and skin settings
3155 * The default Content-Type header.
3157 $wgMimeType = 'text/html';
3160 * Previously used as content type in HTML script tags. This is now ignored since
3161 * HTML5 doesn't require a MIME type for script tags (javascript is the default).
3162 * It was also previously used by RawAction to determine the ctype query parameter
3163 * value that will result in a javascript response.
3164 * @deprecated since 1.22
3166 $wgJsMimeType = null;
3169 * The default xmlns attribute. The option to define this has been removed.
3170 * The value of this variable is no longer used by core and is set to a fixed
3171 * value in Setup.php for compatibility with extensions that depend on the value
3172 * of this variable being set. Such a dependency however is deprecated.
3173 * @deprecated since 1.22
3175 $wgXhtmlDefaultNamespace = null;
3178 * Previously used to determine if we should output an HTML5 doctype.
3179 * This is no longer used as we always output HTML5 now. For compatibility with
3180 * extensions that still check the value of this config it's value is now forced
3181 * to true by Setup.php.
3182 * @deprecated since 1.22
3187 * Defines the value of the version attribute in the <html> tag, if any.
3189 * If your wiki uses RDFa, set it to the correct value for RDFa+HTML5.
3190 * Correct current values are 'HTML+RDFa 1.0' or 'XHTML+RDFa 1.0'.
3191 * See also https://www.w3.org/TR/rdfa-in-html/#document-conformance
3194 $wgHtml5Version = null;
3197 * Temporary variable that allows HTMLForms to be rendered as tables.
3198 * Table based layouts cause various issues when designing for mobile.
3199 * This global allows skins or extensions a means to force non-table based rendering.
3200 * Setting to false forces form components to always render as div elements.
3203 $wgHTMLFormAllowTableFormat = true;
3206 * Temporary variable that applies MediaWiki UI wherever it can be supported.
3207 * Temporary variable that should be removed when mediawiki ui is more
3208 * stable and change has been communicated.
3211 $wgUseMediaWikiUIEverywhere = false;
3214 * Whether to label the store-to-database-and-show-to-others button in the editor
3215 * as "Save page"/"Save changes" if false (the default) or, if true, instead as
3216 * "Publish page"/"Publish changes".
3220 $wgEditSubmitButtonLabelPublish = false;
3223 * Permit other namespaces in addition to the w3.org default.
3225 * Use the prefix for the key and the namespace for the value.
3229 * $wgXhtmlNamespaces['svg'] = 'http://www.w3.org/2000/svg';
3231 * Normally we wouldn't have to define this in the root "<html>"
3232 * element, but IE needs it there in some circumstances.
3234 * This is ignored if $wgMimeType is set to a non-XML MIME type.
3236 $wgXhtmlNamespaces = [];
3239 * Site notice shown at the top of each page
3241 * MediaWiki:Sitenotice page, which will override this. You can also
3242 * provide a separate message for logged-out users using the
3243 * MediaWiki:Anonnotice page.
3248 * If this is set, a "donate" link will appear in the sidebar. Set it to a URL.
3250 $wgSiteSupportPage = '';
3253 * Default skin, for new users and anonymous visitors. Registered users may
3254 * change this to any one of the other available skins in their preferences.
3256 $wgDefaultSkin = 'vector';
3259 * Fallback skin used when the skin defined by $wgDefaultSkin can't be found.
3263 $wgFallbackSkin = 'fallback';
3266 * Specify the names of skins that should not be presented in the list of
3267 * available skins in user preferences. If you want to remove a skin entirely,
3268 * remove it from the skins/ directory and its entry from LocalSettings.php.
3273 * @deprecated since 1.23; use $wgSkipSkins instead
3278 * Allow user Javascript page?
3279 * This enables a lot of neat customizations, but may
3280 * increase security risk to users and server load.
3282 $wgAllowUserJs = false;
3285 * Allow user Cascading Style Sheets (CSS)?
3286 * This enables a lot of neat customizations, but may
3287 * increase security risk to users and server load.
3289 $wgAllowUserCss = false;
3292 * Allow style-related user-preferences?
3294 * This controls whether the `editfont` and `underline` preferences
3295 * are availabe to users.
3297 $wgAllowUserCssPrefs = true;
3300 * Use the site's Javascript page?
3302 $wgUseSiteJs = true;
3305 * Use the site's Cascading Style Sheets (CSS)?
3307 $wgUseSiteCss = true;
3310 * Break out of framesets. This can be used to prevent clickjacking attacks,
3311 * or to prevent external sites from framing your site with ads.
3313 $wgBreakFrames = false;
3316 * The X-Frame-Options header to send on pages sensitive to clickjacking
3317 * attacks, such as edit pages. This prevents those pages from being displayed
3318 * in a frame or iframe. The options are:
3320 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3322 * - 'SAMEORIGIN': Allow framing by pages on the same domain. This can be used
3323 * to allow framing within a trusted domain. This is insecure if there
3324 * is a page on the same domain which allows framing of arbitrary URLs.
3326 * - false: Allow all framing. This opens up the wiki to XSS attacks and thus
3327 * full compromise of local user accounts. Private wikis behind a
3328 * corporate firewall are especially vulnerable. This is not
3331 * For extra safety, set $wgBreakFrames = true, to prevent framing on all pages,
3332 * not just edit pages.
3334 $wgEditPageFrameOptions = 'DENY';
3337 * Disallow framing of API pages directly, by setting the X-Frame-Options
3338 * header. Since the API returns CSRF tokens, allowing the results to be
3339 * framed can compromise your user's account security.
3341 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3342 * - 'SAMEORIGIN': Allow framing by pages on the same domain.
3343 * - false: Allow all framing.
3344 * Note: $wgBreakFrames will override this for human formatted API output.
3346 $wgApiFrameOptions = 'DENY';
3349 * Disable output compression (enabled by default if zlib is available)
3351 $wgDisableOutputCompression = false;
3354 * Abandoned experiment with HTML5-style ID escaping. Normalized IDs a bit
3355 * too aggressively, breaking preexisting content (particularly Cite).
3356 * See T29733, T29694, T29474.
3358 * @deprecated since 1.30, use $wgFragmentMode
3360 $wgExperimentalHtmlIds = false;
3363 * How should section IDs be encoded?
3364 * This array can contain 1 or 2 elements, each of them can be one of:
3365 * - 'html5' is modern HTML5 style encoding with minimal escaping. Displays Unicode
3366 * characters in most browsers' address bars.
3367 * - 'legacy' is old MediaWiki-style encoding, e.g. 啤酒 turns into .E5.95.A4.E9.85.92
3368 * - 'html5-legacy' corresponds to DEPRECATED $wgExperimentalHtmlIds mode. DO NOT use
3369 * it for anything but migration off that mode (see below).
3371 * The first element of this array specifies the primary mode of escaping IDs. This
3372 * is what users will see when they e.g. follow an [[#internal link]] to a section of
3375 * The optional second element defines a fallback mode, useful for migrations.
3376 * If present, it will direct MediaWiki to add empty <span>s to every section with its
3377 * id attribute set to fallback encoded title so that links using the previous encoding
3380 * Example: you want to migrate your wiki from 'legacy' to 'html5'
3382 * On the first step, set this variable to [ 'legacy', 'html5' ]. After a while, when
3383 * all caches (parser, HTTP, etc.) contain only pages generated with this setting,
3384 * flip the value to [ 'html5', 'legacy' ]. This will result in all internal links being
3385 * generated in the new encoding while old links (both external and cached internal) will
3386 * still work. After a long time, you might want to ditch backwards compatibility and
3387 * set it to [ 'html5' ]. After all, pages get edited, breaking incoming links no matter which
3388 * fragment mode is used.
3392 $wgFragmentMode = [ 'legacy', 'html5' ];
3395 * Which ID escaping mode should be used for external interwiki links? See documentation
3396 * for $wgFragmentMode above for details of each mode. Because you can't control external sites,
3397 * this setting should probably always be 'legacy', unless every wiki you link to has converted
3402 $wgExternalInterwikiFragmentMode = 'legacy';
3405 * Abstract list of footer icons for skins in place of old copyrightico and poweredbyico code
3406 * You can add new icons to the built in copyright or poweredby, or you can create
3407 * a new block. Though note that you may need to add some custom css to get good styling
3408 * of new blocks in monobook. vector and modern should work without any special css.
3410 * $wgFooterIcons itself is a key/value array.
3411 * The key is the name of a block that the icons will be wrapped in. The final id varies
3412 * by skin; Monobook and Vector will turn poweredby into f-poweredbyico while Modern
3413 * turns it into mw_poweredby.
3414 * The value is either key/value array of icons or a string.
3415 * In the key/value array the key may or may not be used by the skin but it can
3416 * be used to find the icon and unset it or change the icon if needed.
3417 * This is useful for disabling icons that are set by extensions.
3418 * The value should be either a string or an array. If it is a string it will be output
3419 * directly as html, however some skins may choose to ignore it. An array is the preferred format
3420 * for the icon, the following keys are used:
3421 * - src: An absolute url to the image to use for the icon, this is recommended
3422 * but not required, however some skins will ignore icons without an image
3423 * - srcset: optional additional-resolution images; see HTML5 specs
3424 * - url: The url to use in the a element around the text or icon, if not set an a element will
3426 * - alt: This is the text form of the icon, it will be displayed without an image in
3427 * skins like Modern or if src is not set, and will otherwise be used as
3428 * the alt="" for the image. This key is required.
3429 * - width and height: If the icon specified by src is not of the standard size
3430 * you can specify the size of image to use with these keys.
3431 * Otherwise they will default to the standard 88x31.
3432 * @todo Reformat documentation.
3436 "copyright" => [], // placeholder for the built in copyright icon
3440 // Defaults to point at
3441 // "$wgResourceBasePath/resources/assets/poweredby_mediawiki_88x31.png"
3442 // plus srcset for 1.5x, 2x resolution variants.
3444 "url" => "//www.mediawiki.org/",
3445 "alt" => "Powered by MediaWiki",
3451 * Login / create account link behavior when it's possible for anonymous users
3452 * to create an account.
3453 * - true = use a combined login / create account link
3454 * - false = split login and create account into two separate links
3456 $wgUseCombinedLoginLink = false;
3459 * Display user edit counts in various prominent places.
3461 $wgEdititis = false;
3464 * Some web hosts attempt to rewrite all responses with a 404 (not found)
3465 * status code, mangling or hiding MediaWiki's output. If you are using such a
3466 * host, you should start looking for a better one. While you're doing that,
3467 * set this to false to convert some of MediaWiki's 404 responses to 200 so
3468 * that the generated error pages can be seen.
3470 * In cases where for technical reasons it is more important for MediaWiki to
3471 * send the correct status code than for the body to be transmitted intact,
3472 * this configuration variable is ignored.
3474 $wgSend404Code = true;
3477 * The $wgShowRollbackEditCount variable is used to show how many edits can be rolled back.
3478 * The numeric value of the variable controls how many edits MediaWiki will look back to
3479 * determine whether a rollback is allowed (by checking that they are all from the same author).
3480 * If the value is false or 0, the edits are not counted. Disabling this will prevent MediaWiki
3481 * from hiding some useless rollback links.
3485 $wgShowRollbackEditCount = 10;
3488 * Output a <link rel="canonical"> tag on every page indicating the canonical
3489 * server which should be used, i.e. $wgServer or $wgCanonicalServer. Since
3490 * detection of the current server is unreliable, the link is sent
3493 $wgEnableCanonicalServerLink = false;
3496 * When OutputHandler is used, mangle any output that contains
3497 * <cross-domain-policy>. Without this, an attacker can send their own
3498 * cross-domain policy unless it is prevented by the crossdomain.xml file at
3503 $wgMangleFlashPolicy = true;
3505 /** @} */ # End of output format settings }
3507 /*************************************************************************//**
3508 * @name ResourceLoader settings
3513 * Client-side resource modules.
3515 * Extensions should add their ResourceLoader module definitions
3516 * to the $wgResourceModules variable.
3520 * $wgResourceModules['ext.myExtension'] = [
3521 * 'scripts' => 'myExtension.js',
3522 * 'styles' => 'myExtension.css',
3523 * 'dependencies' => [ 'jquery.cookie', 'jquery.tabIndex' ],
3524 * 'localBasePath' => __DIR__,
3525 * 'remoteExtPath' => 'MyExtension',
3529 $wgResourceModules = [];
3532 * Skin-specific styles for resource modules.
3534 * These are later added to the 'skinStyles' list of the existing module. The 'styles' list can
3535 * not be modified or disabled.
3537 * For example, here is a module "bar" and how skin Foo would provide additional styles for it.
3541 * $wgResourceModules['bar'] = [
3542 * 'scripts' => 'resources/bar/bar.js',
3543 * 'styles' => 'resources/bar/main.css',
3546 * $wgResourceModuleSkinStyles['foo'] = [
3547 * 'bar' => 'skins/Foo/bar.css',
3551 * This is mostly equivalent to:
3555 * $wgResourceModules['bar'] = [
3556 * 'scripts' => 'resources/bar/bar.js',
3557 * 'styles' => 'resources/bar/main.css',
3559 * 'foo' => skins/Foo/bar.css',