Manual:Configuration settings

From mediawiki.org
Jump to navigation Jump to search
Other languages:
Bahasa Indonesia • ‎Deutsch • ‎English • ‎Türkçe • ‎dansk • ‎español • ‎français • ‎italiano • ‎magyar • ‎polski • ‎português • ‎português do Brasil • ‎svenska • ‎čeština • ‎русский • ‎中文 • ‎日本語 • ‎한국어

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 can't 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.27 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

Set $wgUseImageMagick to true to use ImageMagick instead of the builtin functions.

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

  • $wgDBmysql5 (removed in 1.33) – Set to true to set MySQL connection into UTF-8 encoding (experimental)
  • $wgDBTableOptions – MySQL table options to use during installation or update.
  • $wgSQLMode – Value for the MySQL sql_mode parameter

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

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.txt 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.

  • $wgCdnMaxageLagged – Cache timeout for the CDN when DB replica lag is high
  • $wgCdnMaxageStale (introduced in 1.35) – 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 (introduced in 1.34) – Cache TTL for the CDN sent as s-maxage (without ESI) or Surrogate-Control (with ESI).
  • $wgCdnReboundPurgeDelay – Secondary delayed purges of URLs
  • $wgCdnServersNoPurge (introduced in 1.34) – Same as $wgCdnServers , except that MW has no methods to send HTTP PURGE to an origin part of the configured ranges
  • $wgCdnServers (introduced in 1.34) – 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 (introduced in 1.35) – Cache TTL for the user agent sent as max-age, for logged out users.
  • $wgMaxSquidPurgeTitles (removed in 1.27) – Maximum number of titles to purge in any one client operation
  • $wgSquidMaxage (removed in 1.35) – Cache timeout for the squid.
  • $wgSquidPurgeUseHostHeader (deprecated in 1.33) – 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 proxyed.
    But also to send back to the proxy PURGE commands on changes.
  • $wgUseCdn (introduced in 1.34) – Enable/disable page view caching.
  • $wgUseESI (deprecated in 1.33) – If you run Squid3 with ESI support, enable this.
  • $wgUseKeyHeader (removed in 1.34) – Send the Key HTTP header for better caching.
  • $wgUsePrivateIPs – Whether private X-Forwarded-For IPs should be accepted
  • $wgUseSquid (removed in 1.35) – Enable/disable Squid.
  • $wgUseXVO (removed in 1.27) – Send X-Vary-Options header for better caching (requires patched 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

The following setting is no longer used in supported versions of MediaWiki, but still exists for backward compatibility

Skins

  • $wgDefaultSkin – The default skin for new users.
  • $wgFallbackSkin – Fallback skin used when the skin defined by $DefaultSkin can't be found.
  • $wgFooterIcons – Abstract list of footer icons for skins. It replaces the old copyrightico and poweredbyico code, which until MediaWiki 1.27 could be influenced with $CopyrightIcon
  • $wgSkinMetaTags (introduced in 1.36) – An array of open graph tags which should be added by all skins.
  • $wgSkipSkins – Specify the name of skins that should not be presented in the list of available skins.
  • $wgSkipSkin (removed in 1.35) – Specify the name of a skin that should not be presented in the list of available skins.
  • $wgUseCombinedLoginLink – Login / create account link behavior when it's possible for anonymous users to create an account.
  • $wgVectorUseIconWatch – Watch and unwatch as a star icon rather than a link (for Vector skin only).
  • $wgVectorUseSimpleSearch – Search form behavior for Vector skin only.

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.

Tidy

Tidy is an open source tool that cleans up broken HTML. You can use this to ensure that broken HTML in articles doesn't affect the layout of your wiki. While Tidy itself is going to be replaced, the configuration settings can still be used for the replacements.

  • $wgTidyConfig – Configuration of the HTML postprocessing tool to use for fixing invalid HTML code.
  • $wgDebugTidy (removed in 1.33) – Put tidy warnings in HTML comments, only works for internal tidy.
  • $wgTidyBin (removed in 1.33) – Should be set to the path of the tidy binary.
  • $wgTidyConf (removed in 1.33) – Should be set to the path of the tidy configuration file.
  • $wgTidyInternal (removed in 1.33) – Controls the use of the tidy extension to use an in-process tidy library instead of spawning a separate program.
  • $wgTidyOpts (removed in 1.33) – Options passed to tidy on the command line.
  • $wgUseTidy (removed in 1.33) – Use tidy to make sure HTML output is sane.
  • $wgValidateAllHtml (removed in 1.31) – Validate the overall output using tidy and refuse to display the page if it's not valid.
See also: Manual:Build Tidy from source .

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 (introduced in 1.36) – 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 (introduced in 1.36) – Maximum depth (revision count) of reverts that will have their reverted edits marked with the mw-reverted change tag.
  • $wgSiteStatsAsyncFactor (removed in 1.34) – Sets how often site statistics should be updated.

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

Site customization

Frontend

  • $wgOOUIEditPage (removed in 1.30) – Whether to use OOjs UI buttons, checkboxes and summary input in the edit form.
  • $wgPreloadJavaScriptMwUtil (removed in 1.27) – Whether to preload the mediawiki.util module as blocking module in the top queue.
  • $wgUsejQueryThree (removed in 1.31) – Whether to use jQuery 3 (with jQuery Migrate) instead of jQuery 1.

Miscellaneous settings

See also