Manual:Configuration settings

From mediawiki.org
(Redirected from Manual:$wg)
Starting with MediaWiki 1.39 the configuration settings are based on MainConfigSchema.php.

This is an index of all supported configuration settings based on the DefaultSettings.php file.

Never edit DefaultSettings.php; copy appropriate lines to LocalSettings.php instead and amend them as appropriate.

If you cannot find a configuration setting here, see if it is defined in DefaultSettings.php. The variable should have some documentation there.

Settings removed in versions of MediaWiki prior to 1.35 are no longer listed here. Please use the search box to find the relevant manual page (e.g. Manual:$wgAllowAnonymousMinor).
Listed alphabetically | Listed by function | Category:MediaWiki configuration settings

General Settings

Global Objects

  • $wgAutoloadLocalClasses – Array mapping class names to filenames, for autoloading.
  • $wgConf – Create a site configuration object. Not used for much in a default install.

Server URLs and file paths

See also file/image upload path settings.

See also skins path settings.

Files and file uploads

Uploads have to be specially set up to be secure.

Shared uploads

These settings are kept for backward compatibility, see $wgForeignFileRepos for the new setting, or $wgUseInstantCommons if you only need read access to images on Commons.

MIME types

Warning Warning: ↑This is not a configuration setting, but a global state variable. It should be used solely by thumb.php !

See also: Manual:MIME type detection

Images

See also: Manual:Configuring file uploads

DjVu

EXIF

  • $wgShowEXIF – Show EXIF data at the end of file description pages.
  • $wgUpdateCompatibleMetadata – Whether to automatically update the img_metadata field if it is outdated but compatible with the current version.

ImageMagick

SVG

Thumbnail settings

Antivirus

Email settings

See also User Access: $wgEmailConfirmToEdit

Email notification (Enotif) settings

Actual notifications for each user are defined in the options. You can change defaults with $wgDefaultUserOptions .

Database settings

LoadBalancer settings

MySQL-specific

PostgreSQL-specific

  • $wgDBport – Database port. Only used by PostgreSQL.

SQLite-specific

Shared DB settings

Extension fields

  • $wgExtPGNewFields (removed in 1.36) – Extension defined fields to be added to existing tables
  • $wgExtNewTables (removed in 1.36) – Extension Defined tables to be added on schema change
  • $wgExtNewFields (removed in 1.36) – Extension defined fields to be added to existing tables
  • $wgExtNewIndexes (removed in 1.36) – Extension defined indexes to be added to existing tables
  • $wgExtPGAlteredFields (removed in 1.36) – Extension defined columns to be altered in tables
  • $wgExtModifiedFields (removed in 1.36) – Extension defined fields to change existing tables

Content handlers and storage

Performance hacks and limits

Cache

Main page: Manual:Caching
See: Interwiki for Interwiki cache settings.

File Cache

Settings for Server side file caching.

Message Cache

Sidebar Cache

Parser Cache

Memcached settings

Settings for configuring the Memcached memory-based object store (if you are using it) docs/memcached.md has more details.

WAN cache

HTTP proxy (CDN) settings

These settings configure MediaWiki when using a caching HTTP proxy server. They apply to caching using Varnish as well as Squid.

  • $wgCdnMatchParameterOrder – Indicates if should take query parameters order on incoming requests into account for CDN caching
  • $wgCdnMaxageLagged – Cache timeout for the CDN when DB replica lag is high
  • $wgCdnMaxageStale – Cache timeout in seconds when delivering a stale ParserCache response due to PoolCounter contention.
  • $wgCdnMaxageSubstitute – Cache timeout for the CDN when a response is known to be wrong or incomplete (due to load)
  • $wgCdnMaxAge – Cache TTL for the CDN sent as s-maxage (without ESI) or Surrogate-Control (with ESI).
  • $wgCdnReboundPurgeDelay – Secondary delayed purges of URLs
  • $wgCdnServersNoPurge – Same as $wgCdnServers , except no HTTP purges will be sent and CIDR ranges are accepted
  • $wgCdnServers – An array of individual proxy servers to help MediaWiki detect if the request has been proxied.
    But also to send back to the proxy PURGE commands on changes.
  • $wgForcedRawSMaxage – Default maximum age (in seconds) for raw CSS/JavaScript accesses.
  • $wgInternalServer – Internal server name as known to Squid, if different than $wgServer .
  • $wgLoggedOutMaxAge (removed in 1.38) – Cache TTL for the user agent sent as max-age, for logged out users.
  • $wgSquidMaxage (removed in 1.35) – Cache timeout for the squid.
  • $wgSquidPurgeUseHostHeader (removed in 1.42) – Whether to use a Host header in purge requests sent to the proxy servers configured in $wgSquidServers.
  • $wgSquidServersNoPurge (removed in 1.35) – Same as $wgSquidServers , except that MW has no methods to send HTTP PURGE to an origin part of the configured ranges
  • $wgSquidServers (removed in 1.35) – An array of individual proxy servers to help MediaWiki detect if the request has been proxied.
    But also to send back to the proxy PURGE commands on changes.
  • $wgUseCdn – Enable/disable page view caching.
  • $wgUseESI (deprecated in 1.33) – If you run Squid3 with ESI support, enable this.
  • $wgUsePrivateIPs – Whether private X-Forwarded-For IPs should be accepted
  • $wgUseSquid (removed in 1.35) – Enable/disable Squid.
  • $wgVaryOnXFP – Whether to add X-Forwarded-Proto to the Vary header for API requests and RSS/Atom feeds.

HTCP multicast purging

Language, regional and character encoding settings

Timezone settings

Language-specific

English
  • $wgAmericanDates – Use 'mdy' instead of 'dmy' as the default date format, e.g. 'May 12' instead of '12 May'.
Arabic/Hindi
  • $wgTranslateNumerals – For Hindi, Arabic, and other languages with their own numeral systems, use local numerals instead of Western style (0-9) numerals in some areas of the interface.

Output format and skin settings

Output

Skins

ResourceLoader

See ResourceLoader for more information.

Page titles and redirects

Namespaces

Mobile support

Interwiki links and sites

Interwiki cache

See Interwiki cache for more information.

Parser

HTML

  • $wgRawHtml – Allow raw, unchecked HTML in ‎<html>...‎</html> sections.
  • $wgTidyConfig – Configuration of the HTML postprocessing tool to use for fixing invalid HTML code.

Statistics and content analysis

  • $wgActiveUserDays – The number of days within which a person must make edits to be considered an "active" user
  • $wgArticleCountMethod – Method used to determine if a page in a content namespace should be counted as a valid content page (article).
  • $wgDisableCounters (removed in 1.35) – Disable page view counters.
  • $wgExperiencedUserEdits – Determines the number of edits needed to qualify at the "Experienced user" level.
  • $wgExperiencedUserMemberSince – Determines the number of days needed since account creation to qualify at the "Experienced user" level.
  • $wgLearnerEdits – Determines the number of edits needed to qualify at the "Learner" experience level.
  • $wgLearnerMemberSince – Determines the number of days needed since account creation to qualify at the "Learner" experience level.
  • $wgManualRevertSearchRadius – Maximum number of revisions of a page that will be checked against every new edit made to determine whether the edit was a manual revert.
  • $wgRevertedTagMaxDepth – Maximum depth (revision count) of reverts that will have their reverted edits marked with the mw-reverted change tag.

User accounts, authentication

Authentication

User rights, access control and monitoring

Access

Blocking/banning, and some other related settings.

See Manual:Preventing access for more methods and settings concerning access. See also Manual:User rights for more information about $wgGroupPermissions, $wgAddGroups, $wgRemoveGroups, etc.

See User Access for User Access settings.

Security

Cookies

Profiling, testing and debugging

Debug

See also: Manual:How to debug

Profiling

Search

Edit user interface

Maintenance Scripts setting

Recent changes, new pages, watchlist and history

See also Help:Recent changes and $wgDefaultUserOptions .

Feed

  • $wgFeed – Toggle syndication feeds (RSS, Atom e.g. Recentchanges, Newpages) on and off.
  • $wgAdvertisedFeedTypes – Feed types that should be provided by default.
  • $wgFeedCacheTimeout – Minimum timeout for cached Recentchanges feed, in seconds.
  • $wgFeedClasses – Available feeds objects.
  • $wgFeedDiffCutoff – When generating Recentchanges RSS/Atom feed, diffs will not be generated for pages larger than this size.
  • $wgFeedLimit – Set maximum number of results to return in syndication feeds (RSS, Atom) for e.g. Recentchanges, Newpages.
  • $wgOverrideSiteFeed – Override the site's default rss/atom feed that appears on every page.


Copyright

Import/Export

Extensions

Category

Logging

Special pages

Actions

  • $wgActions – Array of allowed values for the "action" parameter for normal pages.

Robot policies

Ajax, Action API and REST API

Ajax

API

Shell and process control

HTTP client

Jobs

Wiki farm

Miscellaneous settings

See also