Manual:Configuration settings

From MediaWiki.org
Jump to: navigation, search
This page contains changes which are not marked for translation.

Language:Project:Language policy English  • dansk • Deutsch • español • français • Bahasa Indonesia • 日本語 • 한국어 • polski • português do Brasil • русский • 中文 • 中文(繁體)‎
Warning Warning: Translation admins: Do not mark this incomplete page for translation.

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

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: Special:MyLanguage/Manual:How to debug

Profiling


Site customization

Ajax

Frontend

Resource loader

See Special:MyLanguage/ResourceLoader for more information.

Namespaces

Output

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

Robot policies

Mobile support

Site Statistics

Skins

Category

Cache

See Interwiki for Interwiki cache settings.

Client side caching

File Cache

Setting 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

Memcached settings

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


Interwiki

Interwiki cache

See Special:MyLanguage/interwiki cache for more information.

Access

Wiki locking, blocking/banning, and some other related settings.

See Manual:User rightsManual:User rights for more methods and settings concerning access. See also Manual:User rightsManual: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 Warning: This is not a configuration setting, but a global state variable. It should be used solely by thumb.php!

See also Special:MyLanguage/Manual:Mime type detection

Images

See also Special:MyLanguage/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.

TeX

In MediaWiki 1.18 and later, these settings are used for the Math extension.

  • $wgMathCheckFiles - Check whether directory and file exist when generating math images.
  • $wgMathDirectory - The file system path of the directory containing LaTeX math images.
  • $wgMathPath - The URL base of the directory containing LaTeX math images.
  • $wgTexvc - Location of the texvc binary.
  • $wgTexvcBackgroundColor - Texvc background color.
  • $wgUseTeX - Enables the use of <math> (TeX) tags (MediaWiki 1.17 and earlier only -- on 1.18 simply enable the Math extension)

See Math extension for further information.

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.

  • $wgAlwaysUseTidy (deprecated in 1.26.0)
  • $wgDebugTidy - Put tidy warnings in HTML comments, only works for internal tidy.
  • $wgTidyBin - Should be set to the path of the tidy binary.
  • $wgTidyConf - Should be set to the path of the tidy configuration file.
  • $wgTidyInternal - Controls the use of the PECL extension to use an inprocess tidy library instead of spawning a separate program.
  • $wgTidyOpts - Options passed to tidy on the command line.
  • $wgUseTidy - 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 Special:MyLanguage/Manual:Build Tidy from source.

Special pages

Recent changes

See also Special:MyLanguage/Help:Recent changes and Manual:$wgDefaultUserOptionsManual:$wgDefaultUserOptions

UDP updates

Send RC updates via UDP. See: Special:MyLanguage/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.

HTCP multicast purging

Extensions

Maintenance Scripts setting

Miscellaneous settings

  • $wgAllUnicodeFixes - Whether to always convert certain Unicode sequences to modern ones regardless of the content language.
  • $wgAntiLockFlags (removed in 1.25) - Anti-lock flags.
  • $wgCompiledFiles - A list of files that should be compiled into a HipHop build, in addition to those listed in $wgAutoloadClasses.
  • $wgGitRepositoryViewers - Map GIT revision numbers and repository URLs to their respective gitweb URLs in Special:Version
  • $wgGitBin - Path to the git binary.
  • $wgExternalDiffEngine - Use external C++ diff engine (module wikidiff from the extensions package).
  • $wgFixArabicUnicode - Set this to true to clean up archaic Unicode sequences in Arabic text.
  • $wgFixMalayalamUnicode - Set this to true to clean up archaic Unicode sequences in Malayalam text (Default true if [[Special:MyLanguage/Manual:$wgLanguageCode|$wgLanguageCode}} = "ml").
  • $wgMaxShellFileSize - Maximum file size created by shell processes under Linux, in KB.
  • $wgMaxShellMemory - Maximum amount of virtual memory available to shell processes under Linux, in KB.
  • $wgMaxShellTime - Maximum CPU time in seconds for shell processes under linux.
  • $wgMemoryLimit - The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to raise PHP's memory limit if it's below this amount.
  • $wgPoolCounterConf - Configuration for processing pool control.
  • $wgShellLocale - Locale for LC_CTYPE.
  • $wgUseAutomaticEditSummaries - Whether MediaWiki should make automatic edit summaries.
  • $wgUseTagFilter - Allow filtering by change tag in recentchanges, history, etc.
  • $wgEnableHtmlDiff (deprecated in 1.16) - Whether to allow visual comparison in diffs.
  • $wgLegacySchemaConversion (deprecated) - Option to speed up the conversion step for large sites when migrating the schema from 1.4 to 1.5.
  • $wgLivePreview (deprecated in 1.15) - Enable live preview, see also [[Special:MyLanguage/Manual:Live preview}}. After 1.15, live preview still exists, but $wgLivePreview is ignored, and only the uselivepreview user preference is considered.
  • $wgUseTrackbacks (deprecated in 1.19) - Whether to use trackbacks.
  • $wgAjaxEditStash - Whether edits should be prepared via AJAX as users type edit summaries.

See also