Open main menu

MediaWiki β

Manual:Configuration settings


Other languages:
dansk • ‎Deutsch • ‎English • ‎español • ‎français • ‎Bahasa Indonesia • ‎日本語 • ‎한국어 • ‎polski • ‎português do Brasil • ‎русский • ‎中文 • ‎中文(繁體)‎

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

Paths

See also Uploads for file/image upload path settings.

See also Skins for skins path settings.

Global Objects

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

MSSQL-specific

MySQL-specific

Oracle-specific

PostgreSQL-specific

  • $wgDBmwschema - Schema that Postgres stores the MediaWiki tables in.

SQLite-specific

Shared DB settings

Compressed Storage Support

  • $wgCompressRevisions - If this is set on, all future revisions will be compressed on page save, but only if zlib support is available and enabled in PHP.
  • $wgDisableOutputCompression - Disable output compression (compression is enabled by default if zlib is available).

Localization

Timezone settings

Language-specific

English
  • $wgAmericanDates - Enable for English module to print dates as eg 'May 12' instead of '12 May'.
Arabic/Hindi
  • $wgTranslateNumerals - For Hindi and Arabic use local numerals instead of Western style (0-9) numerals in interface.

Debug/logging

See also: Manual:How to debug

Profiling


Site customization

Ajax

Frontend

Resource loader

See ResourceLoader for more information.

Namespaces

Output

The following settings are only used if $wgHtml5 is set to "false" (removed in 1.22):

  • $wgDocType (removed in 1.22) - The doc type to use in the <!DOCTYPE !> declaration.
  • $wgDTD (removed in 1.22) - Specifies the DTD in the DOCTYPE declaration for page output.
  • $wgXhtmlDefaultNamespace (removed in 1.22) - Default XHTML namespace

Robot policies

Mobile support

Site Statistics

Skins

Category

Cache

See: Interwiki for Interwiki cache settings.

Client side caching

File Cache

Settings for Server side file caching.

  • $wgFileCacheDepth - Depth of the subdirectory hierarchy to be created under $wgFileCacheDirectory.
  • $wgFileCacheDirectory - Directory where the cached page will be saved when using server-side caching.
  • $wgUseFileCache - This will cache static pages for non-logged-in users to reduce database traffic on public sites.

Message Cache

Sidebar Cache

Parser Cache

  • $wgEnableParserCache (deprecated in 1.26) - Keep parsed pages in a cache (objectcache table, turck, or memcached) to speed up output of the same page viewed by another user with the same options.
  • $wgRenderHashAppend - Append a configured value to the parser cache and the sitenotice cache keys.
  • $wgParserCacheExpireTime - Expiration time (in seconds) of cached parser information
  • $wgParserCacheType - Parser cache setting.

Memcached settings

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


Interwiki

Interwiki cache

See interwiki cache for more information.

Access

Wiki locking, 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.

Rate limiter

API


Wiki locking

  • $wgReadOnly - Disallows editing, displaying the string given as the reason.
  • $wgReadOnlyFile - If this file is found, the database is locked for the reason given in the contents of the file.


Reduction

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 $wgUseInstantCommonsManual:$wgUseInstantCommons if you only need read access to images on Commons.

MIME types

  Warning: This is not a configuration setting, but a global state variable. It should be used solely by thumb.php!
  • $wgVerifyMimeType - Determines if the mime type of uploaded files should be checked
  • $wgMimeTypeBlacklist - Files with these mime types will never be allowed as uploads if $wgVerifyMimeType is enabled.
  • $wgXMLMimeTypes - An array of XML mime types we can detect via MimeMagic.

See also: Manual:Mime type detection

Images

See also: Manual:Configuring file uploads

DjVu

EXIF

  • $wgShowEXIF - Determines whether EXIF metadata is to be displayed. Set to false for not showing data.
  • $wgUpdateCompatibleMetadata - Whether to automatically update the img_metadata field if the metadata field 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

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.
  • $wgAlwaysUseTidy (deprecated in 1.26)
  • $wgDebugTidy - Put tidy warnings in HTML comments, only works for internal tidy.
  • $wgTidyBin (deprecated in 1.26) - Should be set to the path of the tidy binary.
  • $wgTidyConf (deprecated in 1.26) - Should be set to the path of the tidy configuration file.
  • $wgTidyInternal (deprecated in 1.20)- Controls the use of the PECL extension to use an inprocess tidy library instead of spawning a separate program.
  • $wgTidyOpts (deprecated in 1.26) - Options passed to tidy on the command line.
  • $wgUseTidy (deprecated in 1.26) - Use tidy to make sure HTML output is sane.
  • $wgValidateAllHtml - Validate the overall output using tidy and refuse to display the page if it's not valid.
See also: Manual:Build Tidy from source.

Special pages

Recent changes

See also Help:Recent changes and $wgDefaultUserOptions

UDP updates

Send Recent changes updates via UDP. See: Manual:Simple IRC RC Bot


Users

Authentication

User Access

User agent

Cookies

Feed

  • $wgFeed - Toggle syndication feeds on and off.
  • $wgAdvertisedFeedTypes - Which feed types 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 eg Recentchanges, Newpages.
  • $wgOverrideSiteFeed - Override the site's default rss/atom feed that appears on every page.

Copyright

Search

Jobs

Proxies

Squid

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

  • $wgInternalServer - Internal server name as known to Squid, if different.
  • $wgMaxSquidPurgeTitles (removed in 1.27) - Maximum number of titles to purge in any one client operation
  • $wgSquidPurgeUseHostHeader - Whether to use a Host header in purge requests sent to the proxy servers configured in $wgSquidServers.
  • $wgSquidMaxage - Cache timeout for the HTTP proxy.
  • $wgSquidServers - A list of proxy servers (ips if possible) to purge on changes.
  • $wgSquidServersNoPurge - Same as $wgSquidServers, except they aren't purged.
  • $wgUseESI - If you run Squid3 with ESI support, enable this.
  • $wgUseSquid - Enable/disable support for a caching HTTP proxy.
  • $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 and X-Vary-Options headers for API requests and RSS/Atom feeds.

HTCP multicast purging

Extensions

Maintenance Scripts setting

Miscellaneous settings

See also