BlueSpice MediaWiki REL1_27
 All Classes Namespaces Files Functions Variables Groups Pages
DefaultSettings.php File Reference

Variables

 $wgConf = new SiteConfiguration
 
 $wgConfigRegistry
 
 $wgVersion = '1.27.4'
 
 $wgSitename = 'MediaWiki'
 
 $wgAssumeProxiesUseDefaultProtocolPorts = true
 
 $wgServer = WebRequest::detectServer()
 
 $wgCanonicalServer = false
 
 $wgServerName = false
 
 $wgRedirectSources = false
 
 $wgCapitalLinks = true
 
 $wgCapitalLinkOverrides = []
 
 $wgNamespacesWithSubpages
 
 NS_USER
 
 $wgTrackingCategories = []
 
 $wgContentNamespaces = [ NS_MAIN ]
 
Script path settings
 $wgScriptPath = '/wiki'
 
 $wgUsePathInfo
 
 $wgScriptExtension = '.php'
 
URLs and file paths

These various web and file path variables are set to their defaults in Setup.php if they are not explicitly set from LocalSettings.php.

These will relatively rarely need to be set manually, unless you are splitting style sheets or images outside the main document root.

In this section, a "path" is usually a host-relative URL, i.e. a URL without the host part, that starts with a slash. In most cases a full URL is also acceptable. A "directory" is a local file path.

In both paths and directories, trailing slashes should not be included.

 $wgScript = false
 
 $wgLoadScript = false
 
 $wgStylePath = false
 
 $wgStyleSheetPath = &$wgStylePath
 
 $wgLocalStylePath = false
 
 $wgExtensionAssetsPath = false
 
 $wgExtensionDirectory = "{$IP}/extensions"
 
 $wgStyleDirectory = "{$IP}/skins"
 
 $wgArticlePath = false
 
 $wgUploadPath = false
 
 $wgUploadDirectory = false
 
 $wgFileCacheDirectory = false
 
 $wgLogo = false
 
 $wgLogoHD = false
 
 $wgFavicon = '/favicon.ico'
 
 $wgAppleTouchIcon = false
 
 $wgReferrerPolicy = false
 
 $wgTmpDirectory = false
 
 $wgUploadBaseUrl = ''
 
 $wgUploadStashScalerBaseUrl = false
 
 $wgActionPaths = []
 
Files and file uploads
 $wgEnableUploads = false
 
 $wgUploadStashMaxAge = 6 * 3600
 
 $wgAllowImageMoving = true
 
 $wgEnableAsyncUploads = false
 
 $wgIllegalFileChars = ":"
 
 $wgDeletedDirectory = false
 
 $wgImgAuthDetails = false
 
 $wgImgAuthUrlPathMap = []
 
 $wgLocalFileRepo = false
 
 $wgForeignFileRepos = []
 
 $wgUseInstantCommons = false
 
 $wgForeignUploadTargets = []
 
 $wgUploadDialog
 
 $wgFileBackends = []
 
 $wgLockManagers = []
 
 $wgShowEXIF = function_exists( 'exif_read_data' )
 
 $wgUpdateCompatibleMetadata = false
 
 $wgUseSharedUploads = false
 
 $wgSharedUploadPath = "http://commons.wikimedia.org/shared/images"
 
 $wgFetchCommonsDescriptions = false
 
 $wgSharedUploadDirectory = "/var/www/wiki3/images"
 
 $wgSharedUploadDBname = false
 
 $wgSharedUploadDBprefix = ''
 
 $wgCacheSharedUploads = true
 
 $wgAllowCopyUploads = false
 
 $wgCopyUploadsDomains = []
 
 $wgCopyUploadsFromSpecialUpload = false
 
 $wgCopyUploadProxy = false
 
 $wgCopyUploadTimeout = false
 
 $wgMaxUploadSize = 1024 * 1024 * 100
 
 $wgMinUploadChunkSize = 1024
 
 $wgUploadNavigationUrl = false
 
 $wgUploadMissingFileUrl = false
 
 $wgThumbnailScriptPath = false
 
 $wgSharedThumbnailScriptPath = false
 
 $wgHashedUploadDirectory = true
 
 $wgHashedSharedUploadDirectory = true
 
 $wgRepositoryBaseUrl = "https://commons.wikimedia.org/wiki/File:"
 
 $wgFileExtensions = [ 'png', 'gif', 'jpg', 'jpeg', 'webp' ]
 
 $wgFileBlacklist
 
 $wgMimeTypeBlacklist
 
 $wgAllowJavaUploads = false
 
 $wgCheckFileExtensions = true
 
 $wgStrictFileExtensions = true
 
 $wgDisableUploadScriptChecks = false
 
 $wgUploadSizeWarning = false
 
 $wgTrustedMediaFormats
 
 $wgMediaHandlers
 
 $wgContentHandlers
 
 CONTENT_MODEL_JAVASCRIPT
 
 $wgUseImageResize = true
 
 $wgUseImageMagick = false
 
 $wgImageMagickConvertCommand = '/usr/bin/convert'
 
 $wgMaxInterlacingAreas = []
 
 $wgSharpenParameter = '0x0.4'
 
 $wgSharpenReductionThreshold = 0.85
 
 $wgImageMagickTempDir = false
 
 $wgCustomConvertCommand = false
 
 $wgJpegTran = '/usr/bin/jpegtran'
 
 $wgJpegPixelFormat = 'yuv420'
 
 $wgExiv2Command = '/usr/bin/exiv2'
 
 $wgExiftool = '/usr/bin/exiftool'
 
 $wgSVGConverters
 
 $wgSVGConverter = 'ImageMagick'
 
 $wgSVGConverterPath = ''
 
 $wgSVGMaxSize = 5120
 
 $wgSVGMetadataCutoff = 262144
 
 $wgAllowTitlesInSVG = false
 
 $wgMaxImageArea = 1.25e7
 
 $wgMaxAnimatedGifArea = 1.25e7
 
 $wgTiffThumbnailType = false
 
 $wgThumbnailEpoch = '20030516000000'
 
 $wgAttemptFailureEpoch = 1
 
 $wgIgnoreImageErrors = false
 
 $wgGenerateThumbnailOnParse = true
 
 $wgShowArchiveThumbnails = true
 
 $wgEnableAutoRotation = null
 
 $wgAntivirus = null
 
 $wgAntivirusSetup
 
 $wgAntivirusRequired = true
 
 $wgVerifyMimeType = true
 
 $wgMimeTypeFile = 'includes/mime.types'
 
 $wgMimeInfoFile = 'includes/mime.info'
 
 $wgMimeDetectorCommand = null
 
 $wgTrivialMimeDetection = false
 
 $wgXMLMimeTypes
 
 $wgImageLimits
 
 $wgThumbLimits
 
 $wgThumbnailBuckets = null
 
 $wgThumbnailMinimumBucketDistance = 50
 
 $wgUploadThumbnailRenderMap = []
 
 $wgUploadThumbnailRenderMethod = 'jobqueue'
 
 $wgUploadThumbnailRenderHttpCustomHost = false
 
 $wgUploadThumbnailRenderHttpCustomDomain = false
 
 $wgUseTinyRGBForJPGThumbnails = false
 
 $wgGalleryOptions
 
 $wgThumbUpright = 0.75
 
 $wgDirectoryMode = 0777
 
 $wgResponsiveImages = true
 
DJVU settings
 $wgDjvuDump = null
 
 $wgDjvuRenderer = null
 
 $wgDjvuTxt = null
 
 $wgDjvuToXML = null
 
 $wgDjvuPostProcessor = 'pnmtojpeg'
 
 $wgDjvuOutputExtension = 'jpg'
 
Email settings
 $wgEmergencyContact = false
 
 $wgPasswordSender = false
 
 $wgPasswordSenderName = 'MediaWiki Mail'
 
 $wgNoReplyAddress = false
 
 $wgEnableEmail = true
 
 $wgEnableUserEmail = true
 
 $wgUserEmailUseReplyTo = true
 
 $wgPasswordReminderResendTime = 24
 
 $wgNewPasswordExpiry = 3600 * 24 * 7
 
 $wgUserEmailConfirmationTokenExpiry = 7 * 24 * 60 * 60
 
 $wgPasswordExpirationDays = false
 
 $wgPasswordExpireGrace = 3600 * 24 * 7
 
 $wgSMTP = false
 
 $wgAdditionalMailParams = null
 
 $wgAllowHTMLEmail = false
 
 $wgEnotifFromEditor = false
 
 $wgEmailAuthentication = true
 
 $wgEnotifWatchlist = false
 
 $wgEnotifUserTalk = false
 
 $wgEnotifRevealEditorAddress = false
 
 $wgEnotifMinorEdits = true
 
 $wgEnotifImpersonal = false
 
 $wgEnotifMaxRecips = 500
 
 $wgEnotifUseRealName = false
 
 $wgUsersNotifiedOnAllChanges = []
 
Database settings
 $wgDBserver = 'localhost'
 
 $wgDBport = 5432
 
 $wgDBname = 'my_wiki'
 
 $wgDBuser = 'wikiuser'
 
 $wgDBpassword = ''
 
 $wgDBtype = 'mysql'
 
 $wgDBssl = false
 
 $wgDBcompress = false
 
 $wgDBadminuser = null
 
 $wgDBadminpassword = null
 
 $wgSearchType = null
 
 $wgSearchTypeAlternatives = null
 
 $wgDBprefix = ''
 
 $wgDBTableOptions = 'ENGINE=InnoDB'
 
 $wgSQLMode = ''
 
 $wgDBmwschema = null
 
 $wgSQLiteDataDir = ''
 
 $wgAllDBsAreLocalhost = false
 
 $wgSharedDB = null
 
 $wgSharedPrefix = false
 
 $wgSharedTables = [ 'user', 'user_properties' ]
 
 $wgSharedSchema = false
 
 $wgDBservers = false
 
 $wgLBFactoryConf = [ 'class' => 'LBFactorySimple' ]
 
 $wgDataCenterUpdateStickTTL = 10
 
 $wgDBerrorLog = false
 
 $wgDBerrorLogTZ = false
 
 $wgDBmysql5 = false
 
 $wgDBOracleDRCP = false
 
 $wgLocalDatabases = []
 
 $wgSlaveLagWarning = 10
 
 $wgSlaveLagCritical = 30
 
 $wgDBWindowsAuthentication = false
 
Text storage
 $wgCompressRevisions = false
 
 $wgExternalStores = []
 
 $wgExternalServers = []
 
 $wgDefaultExternalStore = false
 
 $wgRevisionCacheExpiry = 0
 
Performance hacks and limits
 $wgMiserMode = false
 
 $wgDisableQueryPages = false
 
 $wgQueryCacheLimit = 1000
 
 $wgWantedPagesThreshold = 1
 
 $wgAllowSlowParserFunctions = false
 
 $wgAllowSchemaUpdates = true
 
 $wgMaxArticleSize = 2048
 
 $wgMemoryLimit = "50M"
 
 $wgTransactionalTimeLimit = 120
 
Cache settings
 $wgCacheDirectory = false
 
 $wgMainCacheType = CACHE_NONE
 
 $wgMessageCacheType = CACHE_ANYTHING
 
 $wgParserCacheType = CACHE_ANYTHING
 
 $wgSessionCacheType = CACHE_ANYTHING
 
 $wgLanguageConverterCacheType = CACHE_ANYTHING
 
 $wgObjectCaches
 
 $wgMainWANCache = false
 
 $wgWANObjectCaches
 
 $wgMainStash = 'db-replicated'
 
 $wgParserCacheExpireTime = 86400
 
 $wgSessionsInMemcached = true
 
 $wgSessionsInObjectCache = true
 
 $wgObjectCacheSessionExpiry = 3600
 
 $wgSessionHandler = null
 
 $wgPHPSessionHandling = 'enable'
 
 $wgMemCachedDebug = false
 
 $wgMemCachedServers = [ '127.0.0.1:11211' ]
 
 $wgMemCachedPersistent = false
 
 $wgMemCachedTimeout = 500000
 
 $wgUseLocalMessageCache = false
 
 $wgAdaptiveMessageCache = false
 
 $wgLocalisationCacheConf
 
 $wgCachePages = true
 
 $wgCacheEpoch = '20030516000000'
 
 $wgGitInfoCacheDirectory = false
 
 $wgStyleVersion = '303'
 
 $wgUseFileCache = false
 
 $wgFileCacheDepth = 2
 
 $wgEnableParserCache = true
 
 $wgRenderHashAppend = ''
 
 $wgEnableSidebarCache = false
 
 $wgSidebarCacheExpiry = 86400
 
 $wgUseGzip = false
 
 $wgUseETag = false
 
 $wgClockSkewFudge = 5
 
 $wgInvalidateCacheOnLocalSettingsChange = true
 
 $wgExtensionInfoMTime = false
 
HTTP proxy (CDN) settings

Many of these settings apply to any HTTP proxy used in front of MediaWiki, although they are referred to as Squid settings for historical reasons.

Achieving a high hit ratio with an HTTP proxy requires special configuration. See https://www.mediawiki.org/wiki/Manual:Squid_caching for more details.

 $wgUseSquid = false
 
 $wgUseESI = false
 
 $wgUseKeyHeader = false
 
 $wgVaryOnXFP = false
 
 $wgInternalServer = false
 
 $wgSquidMaxage = 18000
 
 $wgCdnMaxageLagged = 30
 
 $wgCdnReboundPurgeDelay = 0
 
 $wgCdnMaxageSubstitute = 60
 
 $wgForcedRawSMaxage = 300
 
 $wgSquidServers = []
 
 $wgSquidServersNoPurge = []
 
 $wgSquidPurgeUseHostHeader = true
 
 $wgHTCPRouting = []
 
 $wgHTCPMulticastTTL = 1
 
 $wgUsePrivateIPs = false
 
Language, regional and character encoding settings
 $wgLanguageCode = 'en'
 
 $wgLangObjCacheSize = 10
 
 $wgGrammarForms = []
 
 $wgInterwikiMagic = true
 
 $wgHideInterlanguageLinks = false
 
 $wgExtraInterlanguageLinkPrefixes = []
 
 $wgExtraLanguageNames = []
 
 $wgDummyLanguageCodes
 
 $wgEditEncoding = ''
 
 $wgFixArabicUnicode = true
 
 $wgFixMalayalamUnicode = true
 
 $wgAllUnicodeFixes = false
 
 $wgLegacyEncoding = false
 
 $wgBrowserBlackList
 
 $wgLegacySchemaConversion = false
 
 $wgAmericanDates = false
 
 $wgTranslateNumerals = true
 
 $wgUseDatabaseMessages = true
 
 $wgMsgCacheExpiry = 86400
 
 $wgMaxMsgCacheEntrySize = 10000
 
 $wgDisableLangConversion = false
 
 $wgDisableTitleConversion = false
 
 $wgDefaultLanguageVariant = false
 
 $wgDisabledVariants = []
 
 $wgVariantArticlePath = false
 
 $wgLoginLanguageSelector = false
 
 $wgForceUIMsgAsContentMsg = []
 
 $wgLocaltimezone = null
 
 $wgLocalTZoffset = null
 
Output format and skin settings
 $wgMimeType = 'text/html'
 
 $wgJsMimeType = null
 
 $wgXhtmlDefaultNamespace = null
 
 $wgHtml5 = true
 
 $wgHtml5Version = null
 
 $wgHTMLFormAllowTableFormat = true
 
 $wgUseMediaWikiUIEverywhere = false
 
 $wgXhtmlNamespaces = []
 
 $wgSiteNotice = ''
 
 $wgSiteSupportPage = ''
 
 $wgValidateAllHtml = false
 
 $wgDefaultSkin = 'vector'
 
 $wgFallbackSkin = 'fallback'
 
 $wgSkipSkins = []
 
 $wgSkipSkin = ''
 
 $wgAllowUserJs = false
 
 $wgAllowUserCss = false
 
 $wgAllowUserCssPrefs = true
 
 $wgUseSiteJs = true
 
 $wgUseSiteCss = true
 
 $wgBreakFrames = false
 
 $wgEditPageFrameOptions = 'DENY'
 
 $wgApiFrameOptions = 'DENY'
 
 $wgDisableOutputCompression = false
 
 $wgExperimentalHtmlIds = false
 
 $wgFooterIcons
 
 poweredby
 
 $wgUseCombinedLoginLink = false
 
 $wgEdititis = false
 
 $wgSend404Code = true
 
 $wgShowRollbackEditCount = 10
 
 $wgEnableCanonicalServerLink = false
 
 $wgMangleFlashPolicy = true
 
ResourceLoader settings
 $wgResourceModules = []
 
 $wgResourceModuleSkinStyles = []
 
 $wgResourceLoaderSources = []
 
 $wgResourceBasePath = null
 
 $wgResourceLoaderMaxage
 
 $wgResourceLoaderDebug = false
 
 $wgResourceLoaderMinifierStatementsOnOwnLine = false
 
 $wgResourceLoaderMinifierMaxLineLength = 1000
 
 $wgIncludeLegacyJavaScript = false
 
 $wgLegacyJavaScriptGlobals = true
 
 $wgResourceLoaderMaxQueryLength = false
 
 $wgResourceLoaderValidateJS = true
 
 $wgResourceLoaderValidateStaticJS = false
 
 $wgResourceLoaderLESSVars
 
 $wgResourceLoaderLESSImportPaths
 
 $wgResourceLoaderStorageEnabled = false
 
 $wgResourceLoaderStorageVersion = 1
 
 $wgAllowSiteCSSOnRestrictedPages = false
 
Page title and interwiki link settings
 $wgMetaNamespace = false
 
 $wgMetaNamespaceTalk = false
 
 $wgExtraNamespaces = []
 
 $wgExtraGenderNamespaces = []
 
 $wgNamespaceAliases = []
 
 $wgLegalTitleChars = " %!\"$&'()*,\\-.\\/0-9:;=?@A-Z\\\\^_`a-z~\\x80-\\xFF+"
 
 $wgLocalInterwiki = false
 
 $wgLocalInterwikis = []
 
 $wgInterwikiExpiry = 10800
 
Interwiki caching settings.
 $wgInterwikiCache = false
 
 $wgInterwikiScopes = 3
 
 $wgInterwikiFallbackSite = 'wiki'
 
SiteStore caching settings.
 $wgSitesCacheFile = false
 
Parser settings

*/ # End of title and interwiki settings }

/************************************************************************//**

  • These settings configure the transformation from wikitext to HTML.
  • */

/**

  • Parser configuration. Associative array with the following members:
  • class The class name
  • preprocessorClass The preprocessor class. Two classes are currently available:
  • Preprocessor_Hash, which uses plain PHP arrays for temporary
  • storage, and Preprocessor_DOM, which uses the DOM module for
  • temporary storage. Preprocessor_DOM generally uses less memory;
  • the speed of the two is roughly the same.
  • If this parameter is not given, it uses Preprocessor_DOM if the
  • DOM module is available, otherwise it uses Preprocessor_Hash.
  • The entire associative array will be passed through to the constructor as
  • the first parameter. Note that only Setup.php can use this variable –
  • the configuration will change at runtime via $wgParser member functions, so
  • the contents of this variable will be out-of-date. The variable can only be
  • changed during LocalSettings.php, in particular, it can't be changed during
  • an extension setup function. */ $wgParserConf = [ 'class' => 'Parser',

    'preprocessorClass' => 'Preprocessor_Hash',

];

/**

  • Maximum indent level of toc. */ $wgMaxTocLevel = 999;

/**

  • A complexity limit on template expansion: the maximum number of nodes visited
  • by PPFrame::expand() */ $wgMaxPPNodeCount = 1000000;

/**

  • A complexity limit on template expansion: the maximum number of elements
  • generated by Preprocessor::preprocessToObj(). This allows you to limit the
  • amount of memory used by the Preprocessor_DOM node cache: testing indicates
  • that each element uses about 160 bytes of memory on a 64-bit processor, so
  • this default corresponds to about 155 MB.
  • When the limit is exceeded, an exception is thrown. */ $wgMaxGeneratedPPNodeCount = 1000000;

/**

  • Maximum recursion depth for templates within templates.
  • The current parser adds two levels to the PHP call stack for each template,
  • and xdebug limits the call stack to 100 by default. So this should hopefully
  • stop the parser before it hits the xdebug limit. */ $wgMaxTemplateDepth = 40;

/**

  • See Also
    $wgMaxTemplateDepth */ $wgMaxPPExpandDepth = 40;
    /**
  • URL schemes that should be recognized as valid by wfParseUrl().
  • WARNING: Do not add 'file:' to this or internal file links will be broken.
  • Instead, if you want to support file links, add 'file://'. The same applies
  • to any other protocols with the same name as a namespace. See bug #44011 for
  • more information.
  • See Also
    wfParseUrl */ $wgUrlProtocols = [ 'bitcoin:', 'ftp://', 'ftps://', 'geo:', 'git://', 'gopher://', 'http://', 'https://', 'irc://', 'ircs://', 'magnet:', 'mailto:', 'mms://', 'news:', 'nntp://', 'redis://', 'sftp://', 'sip:', 'sips:', 'sms:', 'ssh://', 'svn://', 'tel:', 'telnet://', 'urn:', 'worldwind://', 'xmpp:', '//' ];
    /**
  • If true, removes (by substituting) templates in signatures. */ $wgCleanSignatures = true;

/**

  • Whether to allow inline image pointing to other websites */ $wgAllowExternalImages = false;

/**

  • If the above is false, you can specify an exception here. Image URLs
  • that start with this string are then rendered, while all others are not.
  • You can use this to set up a trusted, simple repository of images.
  • You may also specify an array of strings to allow multiple sites
  • Examples:
  • * $wgAllowExternalImagesFrom = 'http://127.0.0.1/';
    * $wgAllowExternalImagesFrom = array( 'http://127.0.0.1/', 'http://example.com' );
    *
 $wgAllowExternalImagesFrom = ''
 
 $wgEnableImageWhitelist = true
 
 $wgAllowImageTag = false
 
 $wgTidyConfig = null
 
 $wgUseTidy = false
 
 $wgTidyBin = 'tidy'
 
 $wgTidyConf = $IP . '/includes/tidy/tidy.conf'
 
 $wgTidyOpts = ''
 
 $wgTidyInternal = extension_loaded( 'tidy' )
 
 $wgDebugTidy = false
 
 $wgRawHtml = false
 
 $wgExternalLinkTarget = false
 
 $wgNoFollowLinks = true
 
 $wgNoFollowNsExceptions = []
 
 $wgNoFollowDomainExceptions = [ 'mediawiki.org' ]
 
 $wgAllowDisplayTitle = true
 
 $wgRestrictDisplayTitle = true
 
 $wgExpensiveParserFunctionLimit = 100
 
 $wgPreprocessorCacheThreshold = 1000
 
 $wgEnableScaryTranscluding = false
 
 $wgTranscludeCacheExpiry = 3600
 
Statistics
 $wgArticleCountMethod = 'link'
 
 $wgActiveUserDays = 30
 
User accounts, authentication
 $wgCentralIdLookupProviders
 
 $wgCentralIdLookupProvider = 'local'
 
 $wgPasswordPolicy
 
 $wgAuthManagerConfig = null
 
 $wgAuthManagerAutoConfig
 
 $wgReauthenticateTime
 
 $wgAllowSecuritySensitiveOperationIfCannotReauthenticate
 
 $wgChangeCredentialsBlacklist
 
 $wgRemoveCredentialsBlacklist
 
 $wgPasswordSalt = true
 
 $wgMinimalPasswordLength = false
 
 $wgMaximalPasswordLength = false
 
 $wgInvalidPasswordReset = true
 
 $wgPasswordDefault = 'pbkdf2'
 
 $wgPasswordConfig
 
 $wgPasswordResetRoutes
 
 $wgMaxSigChars = 255
 
 $wgMaxNameChars = 255
 
 $wgReservedUsernames
 
 $wgDefaultUserOptions
 
 $wgHiddenPrefs = []
 
 $wgInvalidUsernameCharacters = '@:'
 
 $wgUserrightsInterwikiDelimiter = '@'
 
 $wgSecureLogin = false
 
 $wgAuthenticationTokenVersion = null
 
 $wgSessionProviders
 
User rights, access control and monitoring
 $wgAutoblockExpiry = 86400
 
 $wgBlockAllowsUTEdit = true
 
 $wgSysopEmailBans = true
 
 $wgBlockCIDRLimit
 
 $wgBlockDisablesLogin = false
 
 $wgWhitelistRead = false
 
 $wgWhitelistReadRegexp = false
 
 $wgEmailConfirmToEdit = false
 
 $wgHideIdentifiableRedirects = true
 
 $wgGroupPermissions = []
 
 $wgRevokePermissions = []
 
 $wgImplicitGroups = [ '*', 'user', 'autoconfirmed' ]
 
 $wgGroupsAddToSelf = []
 
 $wgGroupsRemoveFromSelf = []
 
 $wgRestrictionTypes = [ 'create', 'edit', 'move', 'upload' ]
 
 $wgRestrictionLevels = [ '', 'autoconfirmed', 'sysop' ]
 
 $wgCascadingRestrictionLevels = [ 'sysop' ]
 
 $wgSemiprotectedRestrictionLevels = [ 'autoconfirmed' ]
 
 $wgNamespaceProtection = []
 
 $wgNonincludableNamespaces = []
 
 $wgAutoConfirmAge = 0
 
 $wgAutoConfirmCount = 0
 
 $wgAutopromote
 
 $wgAutopromoteOnce
 
 $wgAutopromoteOnceLogInRC = true
 
 $wgAddGroups = []
 
 $wgRemoveGroups = []
 
 $wgAvailableRights = []
 
 $wgDeleteRevisionsLimit = 0
 
 $wgHideUserContribLimit = 1000
 
 $wgAccountCreationThrottle = 0
 
 $wgSpamRegex = []
 
 $wgSummarySpamRegex = []
 
 $wgEnableDnsBlacklist = false
 
 $wgDnsBlacklistUrls = [ 'http.dnsbl.sorbs.net.' ]
 
 $wgProxyWhitelist = []
 
 $wgApplyIpBlocksToXff = false
 
 $wgRateLimits
 
 $wgRateLimitsExcludedIPs = []
 
 $wgPutIPinRC = true
 
 $wgQueryPageDefaultLimit = 50
 
 $wgPasswordAttemptThrottle
 
 $wgGrantPermissions = []
 
 $wgGrantPermissions ['basic']['autoconfirmed'] = true
 
 $wgGrantPermissions ['basic']['autopatrol'] = true
 
 $wgGrantPermissions ['basic']['editsemiprotected'] = true
 
 $wgGrantPermissions ['basic']['ipblock-exempt'] = true
 
 $wgGrantPermissions ['basic']['nominornewtalk'] = true
 
 $wgGrantPermissions ['basic']['patrolmarks'] = true
 
 $wgGrantPermissions ['basic']['purge'] = true
 
 $wgGrantPermissions ['basic']['read'] = true
 
 $wgGrantPermissions ['basic']['skipcaptcha'] = true
 
 $wgGrantPermissions ['basic']['writeapi'] = true
 
 $wgGrantPermissions ['highvolume']['bot'] = true
 
 $wgGrantPermissions ['highvolume']['apihighlimits'] = true
 
 $wgGrantPermissions ['highvolume']['noratelimit'] = true
 
 $wgGrantPermissions ['highvolume']['markbotedits'] = true
 
 $wgGrantPermissions ['editpage']['edit'] = true
 
 $wgGrantPermissions ['editpage']['minoredit'] = true
 
 $wgGrantPermissions ['editpage']['applychangetags'] = true
 
 $wgGrantPermissions ['editpage']['changetags'] = true
 
 $wgGrantPermissions ['editprotected'] = $wgGrantPermissions['editpage']
 
 $wgGrantPermissions ['editprotected']['editprotected'] = true
 
 $wgGrantPermissions ['editmycssjs'] = $wgGrantPermissions['editpage']
 
 $wgGrantPermissions ['editmycssjs']['editmyusercss'] = true
 
 $wgGrantPermissions ['editmycssjs']['editmyuserjs'] = true
 
 $wgGrantPermissions ['editmyoptions']['editmyoptions'] = true
 
 $wgGrantPermissions ['editinterface'] = $wgGrantPermissions['editpage']
 
 $wgGrantPermissions ['editinterface']['editinterface'] = true
 
 $wgGrantPermissions ['editinterface']['editusercss'] = true
 
 $wgGrantPermissions ['editinterface']['edituserjs'] = true
 
 $wgGrantPermissions ['createeditmovepage'] = $wgGrantPermissions['editpage']
 
 $wgGrantPermissions ['createeditmovepage']['createpage'] = true
 
 $wgGrantPermissions ['createeditmovepage']['createtalk'] = true
 
 $wgGrantPermissions ['createeditmovepage']['move'] = true
 
 $wgGrantPermissions ['createeditmovepage']['move-rootuserpages'] = true
 
 $wgGrantPermissions ['createeditmovepage']['move-subpages'] = true
 
 $wgGrantPermissions ['createeditmovepage']['move-categorypages'] = true
 
 $wgGrantPermissions ['uploadfile']['upload'] = true
 
 $wgGrantPermissions ['uploadfile']['reupload-own'] = true
 
 $wgGrantPermissions ['uploadeditmovefile'] = $wgGrantPermissions['uploadfile']
 
 $wgGrantPermissions ['uploadeditmovefile']['reupload'] = true
 
 $wgGrantPermissions ['uploadeditmovefile']['reupload-shared'] = true
 
 $wgGrantPermissions ['uploadeditmovefile']['upload_by_url'] = true
 
 $wgGrantPermissions ['uploadeditmovefile']['movefile'] = true
 
 $wgGrantPermissions ['uploadeditmovefile']['suppressredirect'] = true
 
 $wgGrantPermissions ['patrol']['patrol'] = true
 
 $wgGrantPermissions ['rollback']['rollback'] = true
 
 $wgGrantPermissions ['blockusers']['block'] = true
 
 $wgGrantPermissions ['blockusers']['blockemail'] = true
 
 $wgGrantPermissions ['viewdeleted']['browsearchive'] = true
 
 $wgGrantPermissions ['viewdeleted']['deletedhistory'] = true
 
 $wgGrantPermissions ['viewdeleted']['deletedtext'] = true
 
 $wgGrantPermissions ['delete']
 
 $wgGrantPermissions ['delete']['delete'] = true
 
 $wgGrantPermissions ['delete']['bigdelete'] = true
 
 $wgGrantPermissions ['delete']['deletelogentry'] = true
 
 $wgGrantPermissions ['delete']['deleterevision'] = true
 
 $wgGrantPermissions ['delete']['undelete'] = true
 
 $wgGrantPermissions ['protect'] = $wgGrantPermissions['editprotected']
 
 $wgGrantPermissions ['protect']['protect'] = true
 
 $wgGrantPermissions ['viewmywatchlist']['viewmywatchlist'] = true
 
 $wgGrantPermissions ['editmywatchlist']['editmywatchlist'] = true
 
 $wgGrantPermissions ['sendemail']['sendemail'] = true
 
 $wgGrantPermissions ['createaccount']['createaccount'] = true
 
 $wgGrantPermissionGroups
 
 $wgEnableBotPasswords = true
 
 $wgBotPasswordsCluster = false
 
 $wgBotPasswordsDatabase = false
 
Proxy scanner settings
 $wgSecretKey = false
 
 $wgProxyList = []
 
Cookie settings
 $wgCookieExpiration = 180 * 86400
 
 $wgExtendedLoginCookies = [ 'UserID', 'Token' ]
 
 $wgExtendedLoginCookieExpiration = null
 
 $wgCookieDomain = ''
 
 $wgCookiePath = '/'
 
 $wgCookieSecure = 'detect'
 
 $wgDisableCookieCheck = false
 
 $wgCookiePrefix = false
 
 $wgCookieHttpOnly = true
 
 $wgCacheVaryCookies = []
 
 $wgSessionName = false
 
LaTeX (mathematical formulas)
 $wgUseTeX = false
 
Profiling, testing and debugging

To enable profiling, edit StartProfiler.php

 $wgDebugLogFile = ''
 
 $wgDebugLogPrefix = ''
 
 $wgDebugRedirects = false
 
 $wgDebugRawPage = false
 
 $wgDebugComments = false
 
 $wgDebugDumpSql = false
 
 $wgTrxProfilerLimits
 
 $wgDebugLogGroups = []
 
 $wgMWLoggerDefaultSpi
 
 $wgShowDebug = false
 
 $wgDebugTimestamps = false
 
 $wgDebugPrintHttpHeaders = true
 
 $wgSpecialVersionShowHooks = false
 
 $wgShowSQLErrors = false
 
 $wgShowExceptionDetails = false
 
 $wgShowDBErrorBacktrace = false
 
 $wgLogExceptionBacktrace = true
 
 $wgShowHostnames = false
 
 $wgOverrideHostname = false
 
 $wgDevelopmentWarnings = false
 
 $wgDeprecationReleaseLimit = false
 
 $wgProfileLimit = 0.0
 
 $wgProfileOnly = false
 
 $wgStatsdServer = false
 
 $wgStatsdMetricPrefix = 'MediaWiki'
 
 $wgPageInfoTransclusionLimit = 50
 
 $wgSiteStatsAsyncFactor = false
 
 $wgParserTestFiles
 
 $wgEnableJavaScriptTest = false
 
 $wgCachePrefix = false
 
 $wgDebugToolbar = false
 
Search
 $wgDisableTextSearch = false
 
 $wgAdvancedSearchHighlighting = false
 
 $wgSearchHighlightBoundaries = '[\p{Z}\p{P}\p{C}]'
 
 $wgOpenSearchTemplate = false
 
 $wgOpenSearchTemplates
 
 $wgEnableOpenSearchSuggest = true
 
 $wgOpenSearchDefaultLimit = 10
 
 $wgOpenSearchDescriptionLength = 100
 
 $wgSearchSuggestCacheExpiry = 1200
 
 $wgDisableSearchUpdate = false
 
 $wgNamespacesToBeSearchedDefault
 
 $wgDisableInternalSearch = false
 
 $wgSearchForwardUrl = null
 
 $wgUseTwoButtonsSearchForm = true
 
 $wgSitemapNamespaces = false
 
 $wgSitemapNamespacesPriorities = false
 
 $wgEnableSearchContributorsByIP = true
 
Edit user interface
 $wgDiff3 = '/usr/bin/diff3'
 
 $wgDiff = '/usr/bin/diff'
 
 $wgPreviewOnOpenNamespaces
 
 $wgUniversalEditButton = true
 
 $wgUseAutomaticEditSummaries = true
 
Maintenance

See also $wgSiteNotice

 $wgCommandLineDarkBg = false
 
 $wgReadOnly = null
 
 $wgReadOnlyFile = false
 
 $wgUpgradeKey = false
 
 $wgGitBin = '/usr/bin/git'
 
 $wgGitRepositoryViewers
 
Recent changes, new pages, watchlist and history
 $wgRCMaxAge = 90 * 24 * 3600
 
 $wgWatchersMaxAge = 180 * 24 * 3600
 
 $wgUnwatchedPageSecret = 1
 
 $wgRCFilterByAge = false
 
 $wgRCLinkLimits = [ 50, 100, 250, 500 ]
 
 $wgRCLinkDays = [ 1, 3, 7, 14, 30 ]
 
 $wgRCFeeds = []
 
 $wgRCEngines
 
 $wgRCWatchCategoryMembership = false
 
 $wgUseRCPatrol = true
 
 $wgUseNPPatrol = true
 
 $wgUseFilePatrol = true
 
 $wgLogAutopatrol = true
 
 $wgFeed = true
 
 $wgFeedLimit = 50
 
 $wgFeedCacheTimeout = 60
 
 $wgFeedDiffCutoff = 32768
 
 $wgOverrideSiteFeed = []
 
 $wgFeedClasses
 
 $wgAdvertisedFeedTypes = [ 'atom' ]
 
 $wgRCShowWatchingUsers = false
 
 $wgRCShowChangedSize = true
 
 $wgRCChangedSizeThreshold = 500
 
 $wgShowUpdatedMarker = true
 
 $wgDisableAnonTalk = false
 
 $wgAllowCategorizedRecentChanges = false
 
 $wgUseTagFilter = true
 
 $wgUnwatchedPageThreshold = false
 
 $wgRecentChangesFlags
 
Copyright and credits settings
 $wgRightsPage = null
 
 $wgRightsUrl = null
 
 $wgRightsText = null
 
 $wgRightsIcon = null
 
 $wgUseCopyrightUpload = false
 
 $wgMaxCredits = 0
 
 $wgShowCreditsIfMax = true
 
Import / Export
 $wgImportSources = []
 
 $wgImportTargetNamespace = null
 
 $wgExportAllowHistory = true
 
 $wgExportMaxHistory = 0
 
 $wgExportAllowListContributors = false
 
 $wgExportMaxLinkDepth = 0
 
 $wgExportFromNamespaces = false
 
 $wgExportAllowAll = false
 
 $wgExportPagelistLimit = 5000
 
Extensions
 $wgExtensionFunctions = []
 
 $wgExtensionMessagesFiles = []
 
 $wgMessagesDirs = []
 
 $wgExtensionEntryPointListFiles = []
 
 $wgParserOutputHooks = []
 
 $wgEnableParserLimitReporting = true
 
 $wgValidSkinNames = []
 
 $wgSpecialPages = []
 
 $wgAutoloadClasses = []
 
 $wgAutoloadAttemptLowercase = true
 
 $wgExtensionCredits = []
 
 $wgAuth = null
 
 $wgHooks = []
 
 $wgServiceWiringFiles
 
 $wgJobClasses
 
 $wgJobTypesExcludedFromDefaultQueue = [ 'AssembleUploadChunks', 'PublishStashedFile' ]
 
 $wgJobBackoffThrottling = []
 
 $wgJobSerialCommitThreshold = false
 
 $wgJobTypeConf
 
 $wgJobQueueAggregator
 
 $wgSpecialPageCacheUpdates
 
 $wgExceptionHooks = []
 
 $wgPagePropLinkInvalidations
 
Categories
 $wgUseCategoryBrowser = false
 
 $wgCategoryMagicGallery = true
 
 $wgCategoryPagingLimit = 200
 
 $wgCategoryCollation = 'uppercase'
 
Logging
 $wgLogTypes
 
 $wgLogRestrictions
 
 $wgFilterLogTypes
 
 $wgLogNames
 
 $wgLogHeaders
 
 $wgLogActions = []
 
 $wgLogActionsHandlers
 
 $wgActionFilteredLogs
 
 $wgNewUserLog = true
 
Special pages (general and miscellaneous)
 $wgAllowSpecialInclusion = true
 
 $wgDisableQueryPageUpdate = false
 
 $wgCountCategorizedImagesAsUsed = false
 
 $wgMaxRedirectLinksRetrieved = 500
 
Actions
 $wgActions
 
Robot (search engine crawler) policy

See also $wgNoFollowLinks.

 $wgDefaultRobotPolicy = 'index,follow'
 
 $wgNamespaceRobotPolicies = []
 
 $wgArticleRobotPolicies = []
 
 $wgExemptFromUserRobotsControl = null
 
AJAX and API

Note: The AJAX entry point which this section refers to is gradually being replaced by the API entry point, api.php. They are essentially equivalent. Both of them are used for dynamic client-side features, via XHR.

 $wgEnableAPI = true
 
 $wgEnableWriteAPI = true
 
 $wgDebugAPI = false
 
 $wgAPIModules = []
 
 $wgAPIFormatModules = []
 
 $wgAPIMetaModules = []
 
 $wgAPIPropModules = []
 
 $wgAPIListModules = []
 
 $wgAPIMaxDBRows = 5000
 
 $wgAPIMaxResultSize = 8388608
 
 $wgAPIMaxUncachedDiffs = 1
 
 $wgAPIMaxLagThreshold = 7
 
 $wgAPIRequestLog = false
 
 $wgAPICacheHelpTimeout = 60 * 60
 
 $wgAPIUselessQueryPages
 
 $wgUseAjax = true
 
 $wgAjaxExportList = []
 
 $wgAjaxUploadDestCheck = true
 
 $wgAjaxLicensePreview = true
 
 $wgAjaxEditStash = true
 
 $wgCrossSiteAJAXdomains = []
 
 $wgCrossSiteAJAXdomainExceptions = []
 
Shell and process control
 $wgMaxShellMemory = 307200
 
 $wgMaxShellFileSize = 102400
 
 $wgMaxShellTime = 180
 
 $wgMaxShellWallClockTime = 180
 
 $wgShellCgroup = false
 
 $wgPhpCli = '/usr/bin/php'
 
 $wgShellLocale = 'en_US.utf8'
 
HTTP client
 $wgHTTPTimeout = 25
 
 $wgAsyncHTTPTimeout = 25
 
 $wgHTTPProxy = false
 
 $wgLocalVirtualHosts = []
 
 $wgHTTPConnectTimeout = 5e0
 
Job queue
 $wgJobRunRate = 1
 
 $wgRunJobsAsync = false
 
 $wgUpdateRowsPerJob = 300
 
 $wgUpdateRowsPerQuery = 100
 
Miscellaneous
 $wgExternalDiffEngine = false
 
 $wgDisableHardRedirects = false
 
 $wgLinkHolderBatchSize = 1000
 
 $wgRegisterInternalExternals = false
 
 $wgMaximumMovedPages = 100
 
 $wgFixDoubleRedirects = false
 
 $wgRedirectOnLogin = null
 
 $wgPoolCounterConf = null
 
 $wgUploadMaintenance = false
 
 $wgNamespaceContentModels = []
 
 $wgContentHandlerTextFallback = 'ignore'
 
 $wgContentHandlerUseDB = true
 
 $wgTextModelsToParse
 
 $wgSiteTypes
 
 $wgPagePropsHaveSortkey = true
 
 $wgHttpsPort = 443
 
 $wgSessionSecret = false
 
 $wgSessionInsecureSecrets = false
 
 $wgHKDFSecret = false
 
 $wgHKDFAlgorithm = 'sha256'
 
 $wgPageLanguageUseDB = false
 
 $wgVirtualRestConfig
 
 $wgSearchRunSuggestedQuery = true
 
 $wgPopularPasswordFile = __DIR__ . '/../serialized/commonpasswords.cdb'
 
 $wgMaxUserDBWriteDuration = false
 
 $wgEventRelayerConfig
 

Detailed Description

Default values for MediaWiki configuration settings.

            NEVER EDIT THIS FILE

To customize your installation, edit "LocalSettings.php". If you make changes here, they will be lost on next upgrade of MediaWiki!

In this file, variables whose default values depend on other variables are set to false. The actual default value of these variables will only be set in Setup.php, taking into account any custom settings performed in LocalSettings.php.

Documentation is in the source and on: https://www.mediawiki.org/wiki/Manual:Configuration_settings

Warning
Note: this (and other things) will break if the autoloader is not enabled. Please include includes/AutoLoader.php before including this file.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. http://www.gnu.org/copyleft/gpl.html

Variable Documentation

$wgAccountCreationThrottle = 0

Number of accounts each IP address may create, 0 to disable.

Warning
Requires $wgMainCacheType to be enabled
$wgActionFilteredLogs
Initial value:
= [
'block' => [
'block' => [ 'block' ]

List of log types that can be filtered by action types

To each action is associated the list of log_action subtypes to search for, usually one, but not necessarily so Extensions may append to this array

Since
1.27
$wgActionPaths = []

To set 'pretty' URL paths for actions other than plain page views, add to this array.

Example:
Set pretty URL for the edit action:
'edit' => "$wgScriptPath/edit/$1"

There must be an appropriate script or rewrite rule in place to handle these URLs.

Since
1.5
$wgActions
Initial value:
= [
'credits' => true

Array of allowed values for the "title=foo&action=<action>" parameter. Syntax is: 'foo' => 'ClassName' Load the specified class which subclasses Action 'foo' => true Load the class FooAction which subclasses Action If something is specified in the getActionOverrides() of the relevant Page object it will be used instead of the default class. 'foo' => false The action is disabled; show an error message Unsetting core actions will probably cause things to complain loudly.

$wgActiveUserDays = 30

How many days user must be idle before he is considered inactive. Will affect the number shown on Special:Statistics, Special:ActiveUsers, and the {{NUMBEROFACTIVEUSERS}} magic word in wikitext. You might want to leave this as the default value, to provide comparable numbers between different wikis.

$wgAdaptiveMessageCache = false

Instead of caching everything, only cache those messages which have been customised in the site content language. This means that MediaWiki:Foo/ja is ignored if MediaWiki:Foo doesn't exist. This option is probably only useful for translatewiki.net.

$wgAddGroups = []

$wgAddGroups and $wgRemoveGroups can be used to give finer control over who can assign which groups at Special:Userrights.

Example:
Bureaucrats can add any group:
$wgAddGroups['bureaucrat'] = true;
Bureaucrats can only remove bots and sysops:
$wgRemoveGroups['bureaucrat'] = array( 'bot', 'sysop' );
Sysops can make bots:
$wgAddGroups['sysop'] = array( 'bot' );
Sysops can disable other sysops in an emergency, and disable bots:
$wgRemoveGroups['sysop'] = array( 'sysop', 'bot' );
$wgAdditionalMailParams = null

Additional email parameters, will be passed as the last argument to mail() call.

$wgAdvancedSearchHighlighting = false

Set to true to have nicer highlighted text in search results, by default off due to execution overhead

$wgAdvertisedFeedTypes = [ 'atom' ]

Which feed types should we provide by default? This can include 'rss', 'atom', neither, or both.

$wgAjaxEditStash = true

Have clients send edits to be prepared when filling in edit summaries. This gives the server a head start on the expensive parsing operation.

$wgAjaxExportList = []

List of Ajax-callable functions. Extensions acting as Ajax callbacks must register here

Deprecated:
(officially) since 1.27; use the API instead
$wgAjaxLicensePreview = true

Enable previewing licences via AJAX. Also requires $wgEnableAPI to be true.

$wgAjaxUploadDestCheck = true

Enable AJAX check for file overwrite, pre-upload

$wgAllDBsAreLocalhost = false

Make all database connections secretly go to localhost. Fool the load balancer thinking there is an arbitrarily large cluster of servers to connect to. Useful for debugging.

$wgAllowCategorizedRecentChanges = false

Enable filtering of categories in Recentchanges

$wgAllowCopyUploads = false

Allow for upload to be copied from an URL. The timeout for copy uploads is set by $wgCopyUploadTimeout. You have to assign the user right 'upload_by_url' to a user group, to use this.

$wgAllowDisplayTitle = true

Allow DISPLAYTITLE to change title display

$wgAllowHTMLEmail = false

For parts of the system that have been updated to provide HTML email content, send both text and HTML parts as the body of the email

$wgAllowImageMoving = true

Allows to move images and other media files

$wgAllowImageTag = false

A different approach to the above: simply allow the "<img>" tag to be used. This allows you to specify alt text and other attributes, copy-paste HTML to your wiki more easily, etc. However, allowing external images in any manner will allow anyone with editing rights to snoop on your visitors' IP addresses and so forth, if they wanted to, by inserting links to images on sites they control.

$wgAllowJavaUploads = false

Allow Java archive uploads. This is not recommended for public wikis since a maliciously-constructed applet running on the same domain as the wiki can steal the user's cookies.

$wgAllowSchemaUpdates = true

Allow schema updates

$wgAllowSecuritySensitiveOperationIfCannotReauthenticate
Initial value:
= [
'default' => true
$wgAllowSiteCSSOnRestrictedPages = false

Whether to allow site-wide CSS (MediaWiki:Common.css and friends) on restricted pages like Special:UserLogin or Special:Preferences where JavaScript is disabled for security reasons. As it is possible to execute JavaScript through CSS, setting this to true opens up a potential security hole. Some sites may "skin" their wiki by using site-wide CSS, causing restricted pages to look unstyled and different from the rest of the site.

Since
1.25
$wgAllowSlowParserFunctions = false

Enable slow parser functions

$wgAllowSpecialInclusion = true

Allow special page inclusions such as {{Special:Allpages}}

$wgAllowTitlesInSVG = false

Disallow <title> element in SVG files.

MediaWiki will reject HTMLesque tags in uploaded files due to idiotic browsers which can not perform basic stuff like MIME detection and which are vulnerable to further idiots uploading crap files as images.

When this directive is on, "<title>" will be allowed in files with an "image/svg+xml" MIME type. You should leave this disabled if your web server is misconfigured and doesn't send appropriate MIME types for SVG images.

$wgAllowUserCss = false

Allow user Cascading Style Sheets (CSS)? This enables a lot of neat customizations, but may increase security risk to users and server load.

$wgAllowUserCssPrefs = true

Allow user-preferences implemented in CSS? This allows users to customise the site appearance to a greater degree; disabling it will improve page load times.

$wgAllowUserJs = false

Allow user Javascript page? This enables a lot of neat customizations, but may increase security risk to users and server load.

$wgAllUnicodeFixes = false

Set this to always convert certain Unicode sequences to modern ones regardless of the content language. This has a small performance impact.

See $wgFixArabicUnicode and $wgFixMalayalamUnicode for conversion details.

Since
1.17
$wgAmericanDates = false

Enable dates like 'May 12' instead of '12 May', if the default date format is 'dmy or mdy'.

$wgAntivirus = null

Internal name of virus scanner. This serves as a key to the $wgAntivirusSetup array. Set this to NULL to disable virus scanning. If not null, every file uploaded will be scanned for viruses.

$wgAntivirusRequired = true

Determines if a failed virus scan (AV_SCAN_FAILED) will cause the file to be rejected.

$wgAntivirusSetup
Initial value:
= [
# setup for clamav
'clamav' => [
'command' => 'clamscan --no-summary '

Configuration for different virus scanners. This an associative array of associative arrays. It contains one setup array per known scanner type. The entry is selected by $wgAntivirus, i.e. valid values for $wgAntivirus are the keys defined in this array.

The configuration array for each scanner contains the following keys: "command", "codemap", "messagepattern":

"command" is the full command to call the virus scanner - f will be replaced with the name of the file to scan. If not present, the filename will be appended to the command. Note that this must be overwritten if the scanner is not in the system path; in that case, please set $wgAntivirusSetup[$wgAntivirus]['command'] to the desired command with full path.

"codemap" is a mapping of exit code to return codes of the detectVirus function in SpecialUpload.

  • An exit code mapped to AV_SCAN_FAILED causes the function to consider the scan to be failed. This will pass the file if $wgAntivirusRequired is not set.
  • An exit code mapped to AV_SCAN_ABORTED causes the function to consider the file to have an unsupported format, which is probably immune to viruses. This causes the file to pass.
  • An exit code mapped to AV_NO_VIRUS will cause the file to pass, meaning no virus was found.
  • All other codes (like AV_VIRUS_FOUND) will cause the function to report a virus.
  • You may use "*" as a key in the array to catch all exit codes not mapped otherwise.

"messagepattern" is a perl regular expression to extract the meaningful part of the scanners output. The relevant part should be matched as group one (\1). If not defined or the pattern does not match, the full message is shown to the user.

$wgAPICacheHelpTimeout = 60 * 60

Set the timeout for the API help text cache. If set to 0, caching disabled

$wgAPIFormatModules = []

API format module extensions. Associative array mapping format module name to module specs (see $wgAPIModules). Extension modules may override the core modules.

See ApiMain::$Formats for a list of the core format modules.

$wgApiFrameOptions = 'DENY'

Disallow framing of API pages directly, by setting the X-Frame-Options header. Since the API returns CSRF tokens, allowing the results to be framed can compromise your user's account security. Options are:

  • 'DENY': Do not allow framing. This is recommended for most wikis.
  • 'SAMEORIGIN': Allow framing by pages on the same domain.
  • false: Allow all framing. Note: $wgBreakFrames will override this for human formatted API output.
$wgAPIListModules = []

API Query list module extensions. Associative array mapping list module name to module specs (see $wgAPIModules). Extension modules may override the core modules.

See ApiQuery::$QueryListModules for a list of the core list modules.

$wgAPIMaxDBRows = 5000

Maximum amount of rows to scan in a DB query in the API The default value is generally fine

$wgAPIMaxLagThreshold = 7

Maximum amount of DB lag on a majority of DB slaves to tolerate before forcing bots to retry any write requests via API errors. This should be lower than the 'max lag' value in $wgLBFactoryConf.

$wgAPIMaxResultSize = 8388608

The maximum size (in bytes) of an API result.

Warning
Do not set this lower than $wgMaxArticleSize*1024
$wgAPIMaxUncachedDiffs = 1

The maximum number of uncached diffs that can be retrieved in one API request. Set this to 0 to disable API diffs altogether

$wgAPIMetaModules = []

API Query meta module extensions. Associative array mapping meta module name to module specs (see $wgAPIModules). Extension modules may override the core modules.

See ApiQuery::$QueryMetaModules for a list of the core meta modules.

$wgAPIModules = []

API module extensions.

Associative array mapping module name to modules specs; Each module spec is an associative array containing at least the 'class' key for the module's class, and optionally a 'factory' key for the factory function to use for the module.

That factory function will be called with two parameters, the parent module (an instance of ApiBase, usually ApiMain) and the name the module was registered under. The return value must be an instance of the class given in the 'class' field.

For backward compatibility, the module spec may also be a simple string containing the module's class name. In that case, the class' constructor will be called with the parent module and module name as parameters, as described above.

Examples for registering API modules:

$wgAPIModules['foo'] = 'ApiFoo';
$wgAPIModules['bar'] = array(
'class' => 'ApiBar',
'factory' => function( $main, $name ) { ... }
);
$wgAPIModules['xyzzy'] = array(
'class' => 'ApiXyzzy',
'factory' => array( 'XyzzyFactory', 'newApiModule' )
);

Extension modules may override the core modules. See ApiMain::$Modules for a list of the core modules.

$wgAPIPropModules = []

API Query prop module extensions. Associative array mapping prop module name to module specs (see $wgAPIModules). Extension modules may override the core modules.

See ApiQuery::$QueryPropModules for a list of the core prop modules.

$wgAPIRequestLog = false

Log file or URL (TCP or UDP) to log API requests to, or false to disable API request logging

$wgAPIUselessQueryPages
Initial value:
= [
'MIMEsearch',
'LinkSearch',
'FileDuplicateSearch',
]

The ApiQueryQueryPages module should skip pages that are redundant to true API queries.

$wgAppleTouchIcon = false

The URL path of the icon for iPhone and iPod Touch web app bookmarks. Defaults to no icon.

Since
1.12
$wgApplyIpBlocksToXff = false

Whether to look at the X-Forwarded-For header's list of (potentially spoofed) IPs and apply IP blocks to them. This allows for IP blocks to work with correctly-configured (transparent) proxies without needing to block the proxies themselves.

$wgArticleCountMethod = 'link'

Method used to determine if a page in a content namespace should be counted as a valid article.

Redirect pages will never be counted as valid articles.

This variable can have the following values:

  • 'any': all pages as considered as valid articles
  • 'comma': the page must contain a comma to be considered valid
  • 'link': the page must contain a [[wiki link]] to be considered valid

See also See https://www.mediawiki.org/wiki/Manual:Article_count

Retroactively changing this variable will not affect the existing count, to update it, you will need to run the maintenance/updateArticleCount.php script.

$wgArticlePath = false

The URL path for primary article page views. This path should contain $1, which is replaced by the article title.

Defaults to "{$wgScript}/$1" or "{$wgScript}?title=$1", depending on $wgUsePathInfo.

$wgArticleRobotPolicies = []

Robot policies per article. These override the per-namespace robot policies. Must be in the form of an array where the key part is a properly canonicalised text form title and the value is a robot policy.

Example:
'Main Page' => 'noindex,follow',
'User:Bob' => 'index,follow',
);
Example that DOES NOT WORK because the names are not canonical text
forms:
# Underscore, not space!
'Main_Page' => 'noindex,follow',
# "Project", not the actual project name!
'Project:X' => 'index,follow',
# Needs to be "Abc", not "abc" (unless $wgCapitalLinks is false for that namespace)!
'abc' => 'noindex,nofollow'
);
$wgAsyncHTTPTimeout = 25

Timeout for Asynchronous (background) HTTP requests, in seconds.

$wgAttemptFailureEpoch = 1

Certain operations are avoided if there were too many recent failures, for example, thumbnail generation. Bump this value to invalidate all memory of failed operations and thus allow further attempts to resume. This is useful when a cause for the failures has been found and fixed.

$wgAuthManagerAutoConfig
Initial value:
= [
'preauth' => [
MediaWiki\Auth\LegacyHookPreAuthenticationProvider::class => [
'class' => MediaWiki\Auth\LegacyHookPreAuthenticationProvider::class
See Also
$wgAuthManagerConfig
Since
1.27
$wgAuthManagerConfig = null

Configure AuthManager

All providers are constructed using ObjectFactory, see that for the general structure. The array may also contain a key "sort" used to order providers: providers are stably sorted by this value, which should be an integer (default is 0).

Elements are:

  • preauth: Array (keys ignored) of specifications for PreAuthenticationProviders
  • primaryauth: Array (keys ignored) of specifications for PrimaryAuthenticationProviders
  • secondaryauth: Array (keys ignored) of specifications for SecondaryAuthenticationProviders
Since
1.27
Note
If this is null or empty, the value from $wgAuthManagerAutoConfig is used instead. Local customization should generally set this variable from scratch to the desired configuration. Extensions that want to auto-configure themselves should use $wgAuthManagerAutoConfig instead.
$wgAutoblockExpiry = 86400

Number of seconds before autoblock entries expire. Default 86400 = 1 day.

$wgAutoConfirmAge = 0

Number of seconds an account is required to age before it's given the implicit 'autoconfirm' group membership. This can be used to limit privileges of new accounts.

Accounts created by earlier versions of the software may not have a recorded creation date, and will always be considered to pass the age test.

When left at 0, all registered accounts will pass.

Example:
Set automatic confirmation to 10 minutes (which is 600 seconds):
$wgAutoConfirmAge = 600; // ten minutes
Set age to one day:
$wgAutoConfirmAge = 3600*24; // one day
$wgAutoConfirmCount = 0

Number of edits an account requires before it is autoconfirmed. Passing both this AND the time requirement is needed. Example:

Example:
$wgAutoloadAttemptLowercase = true

Switch controlling legacy case-insensitive classloading. Do not disable if your wiki must support data created by PHP4, or by MediaWiki 1.4 or earlier.

$wgAutoloadClasses = []

Array mapping class names to filenames, for autoloading.

$wgAutopromote
Initial value:
= [
'autoconfirmed' => [ '&',
[ APCOND_AGE, &$wgAutoConfirmAge ],
]
$wgAutoConfirmCount
Definition: DefaultSettings.php:5298
$wgAutoConfirmAge
Definition: DefaultSettings.php:5287
const APCOND_EDITCOUNT
Definition: Defines.php:248

Automatically add a usergroup to any user who matches certain conditions.

Todo:
Redocument $wgAutopromote

The format is array( '&' or '|' or '^' or '!', cond1, cond2, ... ) where cond1, cond2, ... are themselves conditions; OR APCOND_EMAILCONFIRMED, OR array( APCOND_EMAILCONFIRMED ), OR array( APCOND_EDITCOUNT, number of edits ), OR array( APCOND_AGE, seconds since registration ), OR array( APCOND_INGROUPS, group1, group2, ... ), OR array( APCOND_ISIP, ip ), OR array( APCOND_IPINRANGE, range ), OR array( APCOND_AGE_FROM_EDIT, seconds since first edit ), OR array( APCOND_BLOCKED ), OR array( APCOND_ISBOT ), OR similar constructs defined by extensions.

If $wgEmailAuthentication is off, APCOND_EMAILCONFIRMED will be true for any user who has provided an e-mail address.

$wgAutopromoteOnce
Initial value:
= [
'onEdit' => []

Automatically add a usergroup to any user who matches certain conditions.

Does not add the user to the group again if it has been removed. Also, does not remove the group if the user no longer meets the criteria.

The format is:

array( event => criteria, ... )

Where event is either:

  • 'onEdit' (when user edits)

Criteria has the same format as $wgAutopromote

See Also
$wgAutopromote
Since
1.18
$wgAutopromoteOnceLogInRC = true

Put user rights log entries for autopromotion in recent changes?

Since
1.18
$wgAvailableRights = []

A list of available rights, in addition to the ones defined by the core. For extensions only.

$wgBlockAllowsUTEdit = true

Set this to true to allow blocked users to edit their own user talk page.

$wgBlockCIDRLimit
Initial value:
= [
'IPv4' => 16

Limits on the possible sizes of range blocks.

CIDR notation is hard to understand, it's easy to mistakenly assume that a /1 is a small range and a /31 is a large range. For IPv4, setting a limit of half the number of bits avoids such errors, and allows entire ISPs to be blocked using a small number of range blocks.

For IPv6, RFC 3177 recommends that a /48 be allocated to every residential customer, so range blocks larger than /64 (half the number of bits) will plainly be required. RFC 4692 implies that a very large ISP may be allocated a /19 if a generous HD-Ratio of 0.8 is used, so we will use that as our limit. As of 2012, blocking the whole world would require a /4 range.

$wgBlockDisablesLogin = false

If true, blocked users will not be allowed to login. When using this with a public wiki, the effect of logging out blocked users may actually be avers: unless the user's address is also blocked (e.g. auto-block), logging the user out will again allow reading and editing, just as for anonymous visitors.

$wgBreakFrames = false

Break out of framesets. This can be used to prevent clickjacking attacks, or to prevent external sites from framing your site with ads.

$wgBrowserBlackList
Initial value:
= [
'/^Mozilla\/2\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
'/^Mozilla\/3\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
'/^Mozilla\/4\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
'/^Mozilla\/4\.0 \(compatible; MSIE \d+\.\d+; Mac_PowerPC\)/',
'/^Mozilla\/4\.0 \(compatible; MSIE 6.0; Windows NT 5.0; Google Wireless Transcoder;\)/'
]

Browser Blacklist for unicode non compliant browsers. Contains a list of regexps : "/regexp/" matching problematic browsers. These browsers will be served encoded unicode in the edit box instead of real unicode.

$wgCacheDirectory = false

Directory for caching data in the local filesystem. Should not be accessible from the web.

Note: if multiple wikis share the same localisation cache directory, they must all have the same set of extensions. You can set a directory just for the localisation cache using $wgLocalisationCacheConf['storeDirectory'].

$wgCacheEpoch = '20030516000000'

Set this to current time to invalidate all prior cached pages. Affects both client-side and server-side caching. You can get the current date on your server by using the command:

*   date +%Y%m%d%H%M%S
* 
$wgCachePages = true

Allow client-side caching of pages

$wgCachePrefix = false

Overwrite the caching key prefix with custom value.

Since
1.19
$wgCacheSharedUploads = true

Cache shared metadata in memcached. Don't do this if the commons wiki is in a different memcached domain

$wgCacheVaryCookies = []

A list of cookies that vary the cache (for use by extensions)

$wgCanonicalServer = false

Canonical URL of the server, to use in IRC feeds and notification e-mails. Must be fully qualified, even if $wgServer is protocol-relative.

Defaults to $wgServer, expanded to a fully qualified http:// URL if needed.

Since
1.18
$wgCapitalLinkOverrides = []
Since
1.16 - This can now be set per-namespace. Some special namespaces (such as Special, see MWNamespace::$alwaysCapitalizedNamespaces for the full list) must be true by default (and setting them has no effect), due to various things that require them to be so. Also, since Talk namespaces need to directly mirror their associated content namespaces, the values for those are ignored in favor of the subject namespace's setting. Setting for NS_MEDIA is taken automatically from NS_FILE.
Example:
$wgCapitalLinkOverrides[ NS_FILE ] = false;
$wgCapitalLinks = true

Set this to false to avoid forcing the first letter of links to capitals.

Warning
may break links! This makes links COMPLETELY case-sensitive. Links appearing with a capital at the beginning of a sentence will not go to the same place as links in the middle of a sentence using a lowercase initial.
$wgCascadingRestrictionLevels = [ 'sysop' ]

Restriction levels that can be used with cascading protection

A page can only be protected with cascading protection if the requested restriction level is included in this array.

'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility. 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility.

$wgCategoryCollation = 'uppercase'

Specify how category names should be sorted, when listed on a category page. A sorting scheme is also known as a collation.

Available values are:

  • uppercase: Converts the category name to upper case, and sorts by that.
  • identity: Does no conversion. Sorts by binary value of the string.
  • uca-default: Provides access to the Unicode Collation Algorithm with the default element table. This is a compromise collation which sorts all languages in a mediocre way. However, it is better than "uppercase".

To use the uca-default collation, you must have PHP's intl extension installed. See http://php.net/manual/en/intl.setup.php . The details of the resulting collation will depend on the version of ICU installed on the server.

After you change this, you must run maintenance/updateCollation.php to fix the sort keys in the database.

Extensions can define there own collations by subclassing Collation and using the Collation::factory hook.

$wgCategoryMagicGallery = true

On category pages, show thumbnail gallery for images belonging to that category instead of listing them as articles.

$wgCategoryPagingLimit = 200

Paging limit for categories

$wgCdnMaxageLagged = 30

Cache timeout for the CDN when DB slave lag is high

See Also
$wgSquidMaxage
Since
1.27
$wgCdnMaxageSubstitute = 60

Cache timeout for the CDN when a response is known to be wrong or incomplete (due to load)

See Also
$wgSquidMaxage
Since
1.27
$wgCdnReboundPurgeDelay = 0

If set, any SquidPurge call on a URL or URLs will send a second purge no less than this many seconds later via the job queue. This requires delayed job support. This should be safely higher than the 'max lag' value in $wgLBFactoryConf, so that slave lag does not cause page to be stuck in stales states in CDN.

This also fixes race conditions in two-tiered CDN setups (e.g. cdn2 => cdn1 => MediaWiki). If a purge for a URL reaches cdn2 before cdn1 and a request reaches cdn2 for that URL, it will populate the response from the stale cdn1 value. When cdn1 gets the purge, cdn2 will still be stale. If the rebound purge delay is safely higher than the time to relay a purge to all nodes, then the rebound puge will clear cdn2 after cdn1 was cleared.

Since
1.27
$wgCentralIdLookupProviders
Initial value:
= [
'local' => [ 'class' => 'LocalIdLookup' ],
]

Central ID lookup providers Key is the provider ID, value is a specification for ObjectFactory

Since
1.27
$wgChangeCredentialsBlacklist
Initial value:
= [
\MediaWiki\Auth\TemporaryPasswordAuthenticationRequest::class
]
$wgCheckFileExtensions = true

This is a flag to determine whether or not to check file extensions on upload.

Warning
Setting this to false is insecure for public wikis.
$wgClockSkewFudge = 5

Clock skew or the one-second resolution of time() can occasionally cause cache problems when the user requests two pages within a short period of time. This variable adds a given number of seconds to vulnerable timestamps, thereby giving a grace period.

$wgCommandLineDarkBg = false

For colorized maintenance script output, is your terminal background dark ?

$wgCompressRevisions = false

We can also compress text stored in the 'text' table. If this is set on, new revisions will be compressed on page save if zlib support is available. Any compressed revisions will be decompressed on load regardless of this setting, but will not be readable at all* if zlib support is not available.

$wgConf = new SiteConfiguration

wgConf hold the site configuration. Not used for much in a default install.

Since
1.5
$wgConfigRegistry
Initial value:
= [
'main' => 'GlobalVarConfig::newInstance'
]

Registry of factory functions to create config objects: The 'main' key must be set, and the value should be a valid callable.

Since
1.23
$wgContentHandlers
Initial value:
= [
CONTENT_MODEL_WIKITEXT => 'WikitextContentHandler'
const CONTENT_MODEL_WIKITEXT
Definition: Defines.php:278

Plugins for page content model handling. Each entry in the array maps a model id to a class name or callback that creates an instance of the appropriate ContentHandler subclass.

Since
1.21
$wgContentHandlerTextFallback = 'ignore'

How to react if a plain text version of a non-text Content object is requested using ContentHandler::getContentText():

  • 'ignore': return null
  • 'fail': throw an MWException
  • 'serialize': serialize to default format
Since
1.21
$wgContentHandlerUseDB = true

Set to false to disable use of the database fields introduced by the ContentHandler facility. This way, the ContentHandler facility can be used without any additional information in the database. A page's content model is then derived solely from the page's title. This however means that changing a page's default model (e.g. using $wgNamespaceContentModels) will break the page and/or make the content inaccessible. This also means that pages can not be moved to a title that would default to a different content model.

Overall, with $wgContentHandlerUseDB = false, no database updates are needed, but content handling is less robust and less flexible.

Since
1.21
$wgContentNamespaces = [ NS_MAIN ]

Array of namespaces which can be deemed to contain valid "content", as far as the site statistics are concerned. Useful if additional namespaces also contain "content" which should be considered when generating a count of the number of articles in the wiki.

$wgCookieDomain = ''

Set to set an explicit domain on the login cookies eg, "justthis.domain.org" or ".any.subdomain.net"

$wgCookieExpiration = 180 * 86400

Default cookie lifetime, in seconds. Setting to 0 makes all cookies session-only.

$wgCookieHttpOnly = true

Set authentication cookies to HttpOnly to prevent access by JavaScript, in browsers that support this feature. This can mitigates some classes of XSS attack.

$wgCookiePath = '/'

Set this variable if you want to restrict cookies to a certain path within the domain specified by $wgCookieDomain.

$wgCookiePrefix = false

Cookies generated by MediaWiki have names starting with this prefix. Set it to a string to use a custom prefix. Setting it to false causes the database name to be used as a prefix.

$wgCookieSecure = 'detect'

Whether the "secure" flag should be set on the cookie. This can be:

  • true: Set secure flag
  • false: Don't set secure flag
  • "detect": Set the secure flag if $wgServer is set to an HTTPS URL
$wgCopyUploadProxy = false

Proxy to use for copy upload requests.

Since
1.20
$wgCopyUploadsDomains = []

A list of domains copy uploads can come from

Since
1.20
$wgCopyUploadsFromSpecialUpload = false

Enable copy uploads from Special:Upload. $wgAllowCopyUploads must also be true. If $wgAllowCopyUploads is true, but this is false, you will only be able to perform copy uploads from the API or extensions (e.g. UploadWizard).

$wgCopyUploadTimeout = false

Different timeout for upload by url This could be useful since when fetching large files, you may want a timeout longer than the default $wgHTTPTimeout. False means fallback to default.

Since
1.22
$wgCountCategorizedImagesAsUsed = false

On Special:Unusedimages, consider images "used", if they are put into a category. Default (false) is not to count those as used.

$wgCrossSiteAJAXdomainExceptions = []

Domains that should not be allowed to make AJAX requests, even if they match one of the domains allowed by $wgCrossSiteAJAXdomains Uses the same syntax as $wgCrossSiteAJAXdomains

$wgCrossSiteAJAXdomains = []

Settings for incoming cross-site AJAX requests: Newer browsers support cross-site AJAX when the target resource allows requests from the origin domain by the Access-Control-Allow-Origin header. This is currently only used by the API (requests to api.php) $wgCrossSiteAJAXdomains can be set using a wildcard syntax:

  • '*' matches any number of characters
  • '?' matches any 1 character
Example:
'www.mediawiki.org',
'*.wikipedia.org',
'*.wikimedia.org',
'*.wiktionary.org',
);
$wgCustomConvertCommand = false

Use another resizing converter, e.g. GraphicMagick s will be replaced with the source path, d with the destination w and h will be replaced with the width and height.

Example for GraphicMagick:
$wgCustomConvertCommand = "gm convert %s -resize %wx%h %d"

Leave as false to skip this.

$wgDataCenterUpdateStickTTL = 10

After a state-changing request is done by a client, this determines how many seconds that client should keep using the master datacenter. This avoids unexpected stale or 404 responses due to replication lag.

Since
1.27
$wgDBadminpassword = null

Separate password for maintenance tasks. Leave as null to use the default.

$wgDBadminuser = null

Separate username for maintenance tasks. Leave as null to use the default.

$wgDBcompress = false

Whether to use compression in DB connection.

This setting is only used $wgLBFactoryConf['class'] is set to 'LBFactorySimple' and $wgDBservers is an empty array; otherwise the DBO_COMPRESS flag must be set in the 'flags' option of the database connection to achieve the same functionality.

$wgDBerrorLog = false

File to log database errors to

$wgDBerrorLogTZ = false

Timezone to use in the error log. Defaults to the wiki timezone ($wgLocaltimezone).

A list of usable timezones can found at: http://php.net/manual/en/timezones.php

Examples:
$wgDBerrorLogTZ = 'PST8PDT';
$wgDBerrorLogTZ = 'Europe/Sweden';
Since
1.20
$wgDBmwschema = null

Mediawiki schema

$wgDBmysql5 = false

Set to true to engage MySQL 4.1/5.0 charset-related features; for now will just cause sending of 'SET NAMES=utf8' on connect.

Warning
THIS IS EXPERIMENTAL!

May break if you're not using the table defs from mysql5/tables.sql. May break if you're upgrading an existing wiki if set differently. Broken symptoms likely to include incorrect behavior with page titles, usernames, comments etc containing non-ASCII characters. Might also cause failures on the object cache and other things.

Even correct usage may cause failures with Unicode supplementary characters (those not in the Basic Multilingual Plane) unless MySQL has enhanced their Unicode support.

$wgDBname = 'my_wiki'

Name of the database

$wgDBOracleDRCP = false

Set true to enable Oracle DCRP (supported from 11gR1 onward)

To use this feature set to true and use a datasource defined as POOLED (i.e. in tnsnames definition set server=pooled in connect_data block).

Starting from 11gR1 you can use DCRP (Database Resident Connection Pool) that maintains established sessions and reuses them on new connections.

Not completely tested, but it should fall back on normal connection in case the pool is full or the datasource is not configured as pooled. And the other way around; using oci_pconnect on a non pooled datasource should produce a normal connection.

When it comes to frequent shortlived DB connections like with MW Oracle tends to s***. The problem is the driver connects to the database reasonably fast, but establishing a session takes time and resources. MW does not rely on session state (as it does not use features such as package variables) so establishing a valid session is in this case an unwanted overhead that just slows things down.

Warning
EXPERIMENTAL!
$wgDBpassword = ''

Database user's password

$wgDBport = 5432

Database port number (for PostgreSQL and Microsoft SQL Server).

$wgDBprefix = ''

Table name prefix

$wgDBserver = 'localhost'

Database host name or IP address

$wgDBservers = false

Database load balancer This is a two-dimensional array, an array of server info structures Fields are:

  • host: Host name
  • dbname: Default database name
  • user: DB user
  • password: DB password
  • type: DB type
  • load: Ratio of DB_SLAVE load, must be >=0, the sum of all loads must be >0. If this is zero for any given server, no normal query traffic will be sent to it. It will be excluded from lag checks in maintenance scripts. The only way it can receive traffic is if groupLoads is used.
  • groupLoads: array of load ratios, the key is the query group name. A query may belong to several groups, the most specific group defined here is used.
  • flags: bit field
    • DBO_DEFAULT – turns on DBO_TRX only if !$wgCommandLineMode (recommended)
    • DBO_DEBUG – equivalent of $wgDebugDumpSql
    • DBO_TRX – wrap entire request in a transaction
    • DBO_NOBUFFER – turn off buffering (not useful in LocalSettings.php)
    • DBO_PERSISTENT – enables persistent database connections
    • DBO_SSL – uses SSL/TLS encryption in database connections, if available
    • DBO_COMPRESS – uses internal compression in database connections, if available
  • max lag: (optional) Maximum replication lag before a slave will taken out of rotation

These and any other user-defined properties will be assigned to the mLBInfo member variable of the Database object.

Leave at false to use the single-server variables above. If you set this variable, the single-server variables will generally be ignored (except perhaps in some command-line scripts).

The first server listed in this array (with key 0) will be the master. The rest of the servers will be slaves. To prevent writes to your slaves due to accidental misconfiguration or MediaWiki bugs, set read_only=1 on all your slaves in my.cnf. You can set read_only mode at runtime using:

SET @@read_only=1;

Since the effect of writing to a slave is so damaging and difficult to clean up, we at Wikimedia set read_only=1 in my.cnf on all our DB servers, even our masters, and then set read_only=0 on masters at runtime.

$wgDBssl = false

Whether to use SSL in DB connection.

This setting is only used $wgLBFactoryConf['class'] is set to 'LBFactorySimple' and $wgDBservers is an empty array; otherwise the DBO_SSL flag must be set in the 'flags' option of the database connection to achieve the same functionality.

$wgDBTableOptions = 'ENGINE=InnoDB'

MySQL table options to use during installation or update

$wgDBtype = 'mysql'

Database type

$wgDBuser = 'wikiuser'

Database username

$wgDBWindowsAuthentication = false

Use Windows Authentication instead of $wgDBuser / $wgDBpassword for MS SQL Server

$wgDebugAPI = false

WARNING: SECURITY THREAT - debug use only

Disables many security checks in the API for debugging purposes. This flag should never be used on the production servers, as it introduces a number of potential security holes. Even when enabled, the validation will still be performed, but instead of failing, API will return a warning. Also, there will always be a warning notifying that this flag is set. At this point, the flag allows GET requests to go through for modules requiring POST.

Since
1.21
$wgDebugComments = false

Send debug data to an HTML comment in the output.

This may occasionally be useful when supporting a non-technical end-user. It's more secure than exposing the debug log file to the web, since the output only contains private data for the current user. But it's not ideal for development use since data is lost on fatal errors and redirects.

$wgDebugDumpSql = false

Write SQL queries to the debug log.

This setting is only used $wgLBFactoryConf['class'] is set to 'LBFactorySimple' and $wgDBservers is an empty array; otherwise the DBO_DEBUG flag must be set in the 'flags' option of the database connection to achieve the same functionality.

$wgDebugLogFile = ''

Filename for debug logging. See https://www.mediawiki.org/wiki/How_to_debug The debug log file should be not be publicly accessible if it is used, as it may contain private data.

$wgDebugLogGroups = []

Map of string log group names to log destinations.

If set, wfDebugLog() output for that group will go to that file instead of the regular $wgDebugLogFile. Useful for enabling selective logging in production.

Log destinations may be one of the following:

  • false to completely remove from the output, including from $wgDebugLogFile.
  • string values specifying a filename or URI.
  • associative array with keys:
    • 'destination' desired filename or URI.
    • 'sample' an integer value, specifying a sampling factor (optional)
    • 'level' A constant, indicating the minimum level to log (optional, since 1.25)
Example:
$wgDebugLogGroups['redis'] = '/var/log/mediawiki/redis.log';
Advanced example:
$wgDebugLogGroups['memcached'] = array(
'destination' => '/var/log/mediawiki/memcached.log',
'sample' => 1000, // log 1 message out of every 1,000.
'level' => \Psr\Log\LogLevel::WARNING
);
$wgDebugLogPrefix = ''

Prefix for debug log lines

$wgDebugPrintHttpHeaders = true

Print HTTP headers for every request in the debug information.

$wgDebugRawPage = false

If true, log debugging data from action=raw and load.php. This is normally false to avoid overlapping debug entries due to gen=css and gen=js requests.

$wgDebugRedirects = false

If true, instead of redirecting, show a page with a link to the redirect destination. This allows for the inspection of PHP error messages, and easy resubmission of form data. For developer use only.

$wgDebugTidy = false

Put tidy warnings in HTML comments Only works for internal tidy.

$wgDebugTimestamps = false

Prefix debug messages with relative timestamp. Very-poor man's profiler. Since 1.19 also includes memory usage.

$wgDebugToolbar = false

Display the new debugging toolbar. This also enables profiling on database queries and other useful output. Will be ignored if $wgUseFileCache or $wgUseSquid is enabled.

Since
1.19
$wgDefaultLanguageVariant = false

Default variant code, if false, the default will be the language code

$wgDefaultRobotPolicy = 'index,follow'

Default robot policy. The default policy is to encourage indexing and fol- lowing of links. It may be overridden on a per-namespace and/or per-page basis.

$wgDefaultSkin = 'vector'

Default skin, for new users and anonymous visitors. Registered users may change this to any one of the other available skins in their preferences.

$wgDefaultUserOptions
Initial value:
= [
'ccmeonemails' => 0

Settings added to this array will override the default globals for the user preferences used by anonymous visitors and newly created accounts. For instance, to disable editing on double clicks: $wgDefaultUserOptions ['editondblclick'] = 0;

$wgDeletedDirectory = false

What directory to place deleted uploads in. Defaults to "{$wgUploadDirectory}/deleted".

$wgDeleteRevisionsLimit = 0

Optional to restrict deletion of pages with higher revision counts to users with the 'bigdelete' permission. (Default given to sysops.)

$wgDeprecationReleaseLimit = false

Release limitation to wfDeprecated warnings, if set to a release number development warnings will not be generated for deprecations added in releases after the limit.

$wgDevelopmentWarnings = false

If set to true MediaWiki will throw notices for some possible error conditions and for deprecated functions.

$wgDiff = '/usr/bin/diff'

Path to the GNU diff utility.

$wgDiff3 = '/usr/bin/diff3'

Path to the GNU diff3 utility. If the file doesn't exist, edit conflicts will fall back to the old behavior (no merging).

$wgDirectoryMode = 0777

Default value for chmoding of new directories.

$wgDisableAnonTalk = false

Disable links to talk pages of anonymous users (IPs) in listings on special pages like page history, Special:Recentchanges, etc.

$wgDisableCookieCheck = false

By default, MediaWiki checks if the client supports cookies during the login process, so that it can display an informative error message if cookies are disabled. Set this to true if you want to disable this cookie check.

$wgDisabledVariants = []

Disabled variants array of language variant conversion.

Example:
$wgDisabledVariants[] = 'zh-mo';
$wgDisabledVariants[] = 'zh-my';
$wgDisableHardRedirects = false

Disable redirects to special pages and interwiki redirects, which use a 302 and have no "redirected from" link.

Note
This is only for articles with #REDIRECT in them. URL's containing a local interwiki prefix (or a non-canonical special page name) are still hard redirected regardless of this setting.
$wgDisableInternalSearch = false

Disable the internal MySQL-based search, to allow it to be implemented by an extension instead.

$wgDisableLangConversion = false

Whether to enable language variant conversion.

$wgDisableOutputCompression = false

Disable output compression (enabled by default if zlib is available)

$wgDisableQueryPages = false

Disable all query pages if miser mode is on, not just some

$wgDisableQueryPageUpdate = false

Set this to an array of special page names to prevent maintenance/updateSpecialPages.php from updating those pages.

$wgDisableSearchUpdate = false

If you've disabled search semi-permanently, this also disables updates to the table. If you ever re-enable, be sure to rebuild the search table.

$wgDisableTextSearch = false

Set this to true to disable the full text search feature.

$wgDisableTitleConversion = false

Whether to enable language variant conversion for links.

$wgDisableUploadScriptChecks = false

Setting this to true will disable the upload system's checks for HTML/JavaScript.

Warning
THIS IS VERY DANGEROUS on a publicly editable site, so USE $wgGroupPermissions TO RESTRICT UPLOADING to only those that you trust
$wgDjvuDump = null

Path of the djvudump executable Enable this and $wgDjvuRenderer to enable djvu rendering example: $wgDjvuDump = 'djvudump';

$wgDjvuOutputExtension = 'jpg'

File extension for the DJVU post processor output

$wgDjvuPostProcessor = 'pnmtojpeg'

Shell command for the DJVU post processor Default: pnmtojpeg, since ddjvu generates ppm output Set this to false to output the ppm file directly.

$wgDjvuRenderer = null

Path of the ddjvu DJVU renderer Enable this and $wgDjvuDump to enable djvu rendering example: $wgDjvuRenderer = 'ddjvu';

$wgDjvuToXML = null

Path of the djvutoxml executable This works like djvudump except much, much slower as of version 3.5.

For now we recommend you use djvudump instead. The djvuxml output is probably more stable, so we'll switch back to it as soon as they fix the efficiency problem. http://sourceforge.net/tracker/index.php?func=detail&aid=1704049&group_id=32953&atid=406583

Example:
$wgDjvuToXML = 'djvutoxml';
$wgDjvuTxt = null

Path of the djvutxt DJVU text extraction utility Enable this and $wgDjvuDump to enable text layer extraction from djvu files example: $wgDjvuTxt = 'djvutxt';

$wgDnsBlacklistUrls = [ 'http.dnsbl.sorbs.net.' ]

List of DNS blacklists to use, if $wgEnableDnsBlacklist is true.

This is an array of either a URL or an array with the URL and a key (should the blacklist require a key).

Example:
// String containing URL
'http.dnsbl.sorbs.net.',
// Array with URL and key, for services that require a key
array( 'dnsbl.httpbl.net.', 'mykey' ),
// Array with just the URL. While this works, it is recommended that you
// just use a string as shown above
array( 'opm.tornevall.org.' )
);
Note
You should end the domain name with a . to avoid searching your eventual domain search suffixes.
Since
1.16
$wgDummyLanguageCodes
Initial value:
= [
'als' => 'gsw'

List of language codes that don't correspond to an actual language. These codes are mostly left-offs from renames, or other legacy things. This array makes them not appear as a selectable language on the installer, and excludes them when running the transstat.php script.

$wgEditEncoding = ''

Character set for use in the article edit box. Language-specific encodings may be defined.

This historic feature is one of the first that was added by former MediaWiki team leader Brion Vibber, and is used to support the Esperanto x-system.

$wgEdititis = false

Display user edit counts in various prominent places.

$wgEditPageFrameOptions = 'DENY'

The X-Frame-Options header to send on pages sensitive to clickjacking attacks, such as edit pages. This prevents those pages from being displayed in a frame or iframe. The options are:

  • 'DENY': Do not allow framing. This is recommended for most wikis.
  • 'SAMEORIGIN': Allow framing by pages on the same domain. This can be used to allow framing within a trusted domain. This is insecure if there is a page on the same domain which allows framing of arbitrary URLs.
  • false: Allow all framing. This opens up the wiki to XSS attacks and thus full compromise of local user accounts. Private wikis behind a corporate firewall are especially vulnerable. This is not recommended.

For extra safety, set $wgBreakFrames = true, to prevent framing on all pages, not just edit pages.

$wgEmailAuthentication = true

Require email authentication before sending mail to an email address. This is highly recommended. It prevents MediaWiki from being used as an open spam relay.

$wgEmailConfirmToEdit = false

Should editors be required to have a validated e-mail address before being allowed to edit?

$wgEmergencyContact = false

Site admin email address.

Defaults to "wikiadmin@$wgServerName".

$wgEnableAPI = true

Enable the MediaWiki API for convenient access to machine-readable data via api.php

See https://www.mediawiki.org/wiki/API

$wgEnableAsyncUploads = false

Enable deferred upload tasks that use the job queue. Only enable this if job runners are set up for both the 'AssembleUploadChunks' and 'PublishStashedFile' job types.

Note
If you use suhosin, this setting is incompatible with suhosin.session.encrypt.
$wgEnableAutoRotation = null

If set to true, images that contain certain the exif orientation tag will be rotated accordingly. If set to null, try to auto-detect whether a scaler is available that can rotate.

$wgEnableCanonicalServerLink = false

Output a <link rel="canonical"> tag on every page indicating the canonical server which should be used, i.e. $wgServer or $wgCanonicalServer. Since detection of the current server is unreliable, the link is sent unconditionally.

$wgEnableDnsBlacklist = false

Whether to use DNS blacklists in $wgDnsBlacklistUrls to check for open proxies

Since
1.16
$wgEnableEmail = true

Set to true to enable the e-mail basic features: Password reminders, etc. If sending e-mail on your server doesn't work, you might want to disable this.

$wgEnableImageWhitelist = true

If $wgAllowExternalImages is false, you can allow an on-wiki whitelist of regular expression fragments to match the image URL against. If the image matches one of the regular expression fragments, The image will be displayed.

Set this to true to enable the on-wiki whitelist (MediaWiki:External image whitelist) Or false to disable it

$wgEnableJavaScriptTest = false

Allow running of javascript test suites via [[Special:JavaScriptTest]] (such as QUnit).

$wgEnableOpenSearchSuggest = true

Enable OpenSearch suggestions requested by MediaWiki. Set this to false if you've disabled scripts that use api?action=opensearch and want reduce load caused by cached scripts still pulling suggestions. It will let the API fallback by responding with an empty array.

$wgEnableParserCache = true

Kept for extension compatibility; see $wgParserCacheType

Deprecated:
1.26
$wgEnableParserLimitReporting = true

Whether to include the NewPP limit report as a HTML comment

$wgEnableScaryTranscluding = false

Enable interwiki transcluding. Only when iw_trans=1 in the interwiki table.

$wgEnableSearchContributorsByIP = true

If true, searches for IP addresses will be redirected to that IP's contributions page. E.g. searching for "1.2.3.4" will redirect to [[Special:Contributions/1.2.3.4]]

$wgEnableSidebarCache = false

If on, the sidebar navigation links are cached for users with the current language set. This can save a touch of load on a busy site by shaving off extra message lookups.

However it is also fragile: changing the site configuration, or having a variable $wgArticlePath, can produce broken links that don't update as expected.

$wgEnableUploads = false

Uploads have to be specially set up to be secure

$wgEnableUserEmail = true

Set to true to enable user-to-user e-mail. This can potentially be abused, as it's hard to track.

$wgEnableWriteAPI = true

Allow the API to be used to perform write operations (page edits, rollback, etc.) when an authorised user accesses it

$wgEnotifFromEditor = false

True: from page editor if s/he opted-in. False: Enotif mails appear to come from $wgEmergencyContact

$wgEnotifImpersonal = false

Send a generic mail instead of a personalised mail for each user. This always uses UTC as the time zone, and doesn't include the username.

For pages with many users watching, this can significantly reduce mail load. Has no effect when using sendmail rather than SMTP.

$wgEnotifMaxRecips = 500

Maximum number of users to mail at once when using impersonal mail. Should match the limit on your mail server.

$wgEnotifMinorEdits = true

Send notification mails on minor edits to watchlist pages. This is enabled by default. User talk notifications are affected by this, $wgEnotifUserTalk, and the nominornewtalk user right.

$wgEnotifRevealEditorAddress = false

Set the Reply-to address in notifications to the editor's address, if user allowed this in the preferences.

$wgEnotifUseRealName = false

Use real name instead of username in e-mail "from" field.

$wgEnotifUserTalk = false

Allow users to enable email notification ("enotif") when someone edits their user talk page.

$wgEnotifWatchlist = false

Allow users to enable email notification ("enotif") on watchlist changes.

$wgEventRelayerConfig
Initial value:
= [
'default' => [
'class' => 'EventRelayerNull'

Mapping of event channels (or channel categories) to EventRelayer configuration.

By setting up a PubSub system (like Kafka) and enabling a corresponding EventRelayer class that uses it, MediaWiki can broadcast events to all subscribers. Certain features like WAN cache purging and CDN cache purging will emit events to this system. Appropriate listers can subscribe to the channel and take actions based on the events. For example, a local daemon can run on each CDN cache node and perfom local purges based on the URL purge channel events.

Some extensions may want to use "channel categories" so that different channels can also share the same custom relayer instance (e.g. when it's likely to be overriden). They can use EventRelayerGroup::getRelayer() based on the category but call notify() on various different actual channels. One reason for this would be that some system have very different performance vs durability needs, so one system (e.g. Kafka) may not be suitable for all uses.

The 'default' key is for all channels (or channel categories) without an explicit entry here.

Since
1.27
$wgExceptionHooks = []

Hooks that are used for outputting exceptions. Format is: $wgExceptionHooks[] = $funcname or: $wgExceptionHooks[] = array( $class, $funcname ) Hooks should return strings or false

$wgExemptFromUserRobotsControl = null

An array of namespace keys in which the INDEX/__NOINDEX__ magic words will not function, so users can't decide whether pages in that namespace are indexed by search engines. If set to null, default to $wgContentNamespaces.

Example:
$wgExemptFromUserRobotsControl = array( NS_MAIN, NS_TALK, NS_PROJECT );
$wgExiftool = '/usr/bin/exiftool'

Path to exiftool binary. Used for lossless ICC profile swapping.

Since
1.26
$wgExiv2Command = '/usr/bin/exiv2'

Some tests and extensions use exiv2 to manipulate the Exif metadata in some image formats.

$wgExpensiveParserFunctionLimit = 100

Maximum number of calls per parse to expensive parser functions such as PAGESINCATEGORY.

$wgExperimentalHtmlIds = false

Should we allow a broader set of characters in id attributes, per HTML5? If not, use only HTML 4-compatible IDs. This option is for testing – when the functionality is ready, it will be on by default with no option.

Currently this appears to work fine in all browsers, but it's disabled by default because it normalizes id's a bit too aggressively, breaking preexisting content (particularly Cite). See bug 27733, bug 27694, bug 27474.

$wgExportAllowAll = false

Whether to allow exporting the entire wiki into a single file

$wgExportAllowHistory = true

If set to false, disables the full-history option on Special:Export. This is currently poorly optimized for long edit histories, so is disabled on Wikimedia's sites.

$wgExportAllowListContributors = false

Return distinct author list (when not returning full history)

$wgExportFromNamespaces = false

Whether to allow the "export all pages in namespace" option

$wgExportMaxHistory = 0

If set nonzero, Special:Export requests for history of pages with more revisions than this will be rejected. On some big sites things could get bogged down by very very long pages.

$wgExportMaxLinkDepth = 0

If non-zero, Special:Export accepts a "pagelink-depth" parameter up to this specified level, which will cause it to include all pages linked to from the pages you specify. Since this number can become insanely large and could easily break your wiki, it's disabled by default for now.

Warning
There's a HARD CODED limit of 5 levels of recursion to prevent a crazy-big export from being done by someone setting the depth number too high. In other words, last resort safety net.
$wgExportPagelistLimit = 5000

Maximum number of pages returned by the GetPagesFromCategory and GetPagesFromNamespace functions.

Since
1.27
$wgExtendedLoginCookieExpiration = null

Default login cookie lifetime, in seconds. Setting $wgExtendLoginCookieExpiration to null will use $wgCookieExpiration to calculate the cookie lifetime. As with $wgCookieExpiration, 0 will make login cookies session-only.

$wgExtensionAssetsPath = false

The URL path of the extensions directory. Defaults to "{$wgResourceBasePath}/extensions".

Since
1.16
$wgExtensionCredits = []

An array of information about installed extensions keyed by their type.

All but 'name', 'path' and 'author' can be omitted.

$wgExtensionCredits[$type][] = array(
'path' => __FILE__,
'name' => 'Example extension',
'namemsg' => 'exampleextension-name',
'author' => array(
'Foo Barstein',
),
'version' => '1.9.0',
'url' => 'http://example.org/example-extension/',
'descriptionmsg' => 'exampleextension-desc',
'license-name' => 'GPL-2.0+',
);

The extensions are listed on Special:Version. This page also looks for a file named COPYING or LICENSE (optional .txt extension) and provides a link to view said file. When the 'license-name' key is specified, this file is interpreted as wikitext.

  • $type: One of 'specialpage', 'parserhook', 'variable', 'media', 'antispam', 'skin', 'api', or 'other', or any additional types as specified through the ExtensionTypes hook as used in SpecialVersion::getExtensionTypes().
  • name: Name of extension as an inline string instead of localizable message. Do not omit this even if 'namemsg' is provided, as it is used to override the path Special:Version uses to find extension's license info, and is required for backwards-compatibility with MediaWiki 1.23 and older.
  • namemsg (since MW 1.24): A message key for a message containing the extension's name, if the name is localizable. (For example, skin names usually are.)
  • author: A string or an array of strings. Authors can be linked using the regular wikitext link syntax. To have an internationalized version of "and others" show, add an element "...". This element can also be linked, for instance "[http://example ...]".
  • descriptionmsg: A message key or an an array with message key and parameters: `'descriptionmsg' => 'exampleextension-desc',`
  • description: Description of extension as an inline string instead of localizable message (omit in favour of 'descriptionmsg').
  • license-name: Short name of the license (used as label for the link), such as "GPL-2.0+" or "MIT" (https://spdx.org/licenses/ for a list of identifiers).
$wgExtensionDirectory = "{$IP}/extensions"

Filesystem extensions directory. Defaults to "{$IP}/extensions".

Since
1.25
$wgExtensionEntryPointListFiles = []

Array of files with list(s) of extension entry points to be used in maintenance/mergeMessageFileList.php

Since
1.22
$wgExtensionFunctions = []

A list of callback functions which are called once MediaWiki is fully initialised

$wgExtensionMessagesFiles = []

Extension messages files.

Associative array mapping extension name to the filename where messages can be found. The file should contain variable assignments. Any of the variables present in languages/messages/MessagesEn.php may be defined, but $messages is the most common.

Variables defined in extensions will override conflicting variables defined in the core.

Since MediaWiki 1.23, use of this variable to define messages is discouraged; instead, store messages in JSON format and use $wgMessagesDirs. For setting other variables than $messages, $wgExtensionMessagesFiles should still be used. Use a DIFFERENT key because any entry having a key that also exists in $wgMessagesDirs will be ignored.

Extensions using the JSON message format can preserve backward compatibility with earlier versions of MediaWiki by using a compatibility shim, such as one generated by the generateJsonI18n.php maintenance script, listing it under the SAME key as for the $wgMessagesDirs entry.

Example:
$wgExtensionMessagesFiles['ConfirmEdit'] = __DIR__.'/ConfirmEdit.i18n.php';
$wgExternalDiffEngine = false

Name of the external diff engine to use. Supported values:

  • string: path to an external diff executable
  • false: wikidiff2 PHP/HHVM module if installed, otherwise the default PHP implementation
  • 'wikidiff', 'wikidiff2', and 'wikidiff3' are treated as false for backwards compatibility
$wgExternalLinkTarget = false

Set a default target for external links, e.g. _blank to pop up a new window.

This will also set the "noreferrer" and "noopener" link rel to prevent the attack described at https://mathiasbynens.github.io/rel-noopener/ . Some older browsers may not support these link attributes, hence setting $wgExternalLinkTarget to _blank may represent a security risk to some of your users.

$wgExternalServers = []

An array of external MySQL servers.

Example:
Create a cluster named 'cluster1' containing three servers:
'cluster1' => array( 'srv28', 'srv29', 'srv30' )
);

Used by LBFactorySimple, may be ignored if $wgLBFactoryConf is set to another class.

$wgExternalStores = []

External stores allow including content from non database sources following URL links.

Short names of ExternalStore classes may be specified in an array here:

$wgExternalStores = array("http","file","custom")...

CAUTION: Access to database might lead to code execution

$wgExtraGenderNamespaces = []

Same as above, but for namespaces with gender distinction. Note: the default form for the namespace should also be set using $wgExtraNamespaces for the same index.

Since
1.18
$wgExtraInterlanguageLinkPrefixes = []

List of additional interwiki prefixes that should be treated as interlanguage links (i.e. placed in the sidebar). Notes:

  • This will not do anything unless the prefixes are defined in the interwiki map.
  • The display text for these custom interlanguage links will be fetched from the system message "interlanguage-link-xyz" where xyz is the prefix in this array.
  • A friendly name for each site, used for tooltip text, may optionally be placed in the system message "interlanguage-link-sitename-xyz" where xyz is the prefix in this array.
$wgExtraLanguageNames = []

List of language names or overrides for default names in Names.php

$wgExtraNamespaces = []

Additional namespaces. If the namespaces defined in Language.php and Namespace.php are insufficient, you can create new ones here, for example, to import Help files in other languages. You can also override the namespace names of existing namespaces. Extensions should use the CanonicalNamespaces hook or extension.json.

Warning
Once you delete a namespace, the pages in that namespace will no longer be accessible. If you rename it, then you can access them through the new namespace name.

Custom namespaces should start at 100 to avoid conflicting with standard namespaces, and should always follow the even/odd main/talk pattern.

Example:
100 => "Hilfe",
101 => "Hilfe_Diskussion",
102 => "Aide",
103 => "Discussion_Aide"
);
Todo:
Add a note about maintenance/namespaceDupes.php
$wgFallbackSkin = 'fallback'

Fallback skin used when the skin defined by $wgDefaultSkin can't be found.

Since
1.24
$wgFavicon = '/favicon.ico'

The URL path of the shortcut icon.

Since
1.6
$wgFeed = true

Provide syndication feeds (RSS, Atom) for, e.g., Recentchanges, Newpages

$wgFeedCacheTimeout = 60

Minimum timeout for cached Recentchanges feed, in seconds. A cached version will continue to be served out even if changes are made, until this many seconds runs out since the last render.

If set to 0, feed caching is disabled. Use this for debugging only; feed generation can be pretty slow with diffs.

$wgFeedClasses
Initial value:
= [
'rss' => 'RSSFeed'

Available feeds objects. Should probably only be defined when a page is syndicated ie when $wgOut->isSyndicated() is true.

$wgFeedDiffCutoff = 32768

When generating Recentchanges RSS/Atom feed, diffs will not be generated for pages larger than this size.

$wgFeedLimit = 50

Set maximum number of results to return in syndication feeds (RSS, Atom) for eg Recentchanges, Newpages.

$wgFetchCommonsDescriptions = false

Fetch commons image description pages and display them on the local wiki?

$wgFileBackends = []

File backend structure configuration.

This is an array of file backend configuration arrays. Each backend configuration has the following parameters:

  • 'name' : A unique name for the backend
  • 'class' : The file backend class to use
  • 'wikiId' : A unique string that identifies the wiki (container prefix)
  • 'lockManager' : The name of a lock manager (see $wgLockManagers)

See FileBackend::__construct() for more details. Additional parameters are specific to the file backend class used. These settings should be global to all wikis when possible.

There are two particularly important aspects about each backend:

  • a) Whether it is fully qualified or wiki-relative. By default, the paths of files are relative to the current wiki, which works via prefixing them with the current wiki ID when accessed. Setting 'wikiId' forces the backend to be fully qualified by prefixing all paths with the specified value instead. This can be useful if multiple wikis need to share the same data. Note that 'name' is not part of any prefix and thus should not be relied upon for namespacing.
  • b) Whether it is only defined for some wikis or is defined on all wikis in the wiki farm. Defining a backend globally is useful if multiple wikis need to share the same data. One should be aware of these aspects when configuring a backend for use with any basic feature or plugin. For example, suppose an extension stores data for different wikis in different directories and sometimes needs to access data from a foreign wiki's directory in order to render a page on given wiki. The extension would need a fully qualified backend that is defined on all wikis in the wiki farm.
$wgFileBlacklist
Initial value:
= [
# HTML may contain cookie-stealing JavaScript and web bugs
'html', 'htm', 'js', 'jsb', 'mhtml', 'mht', 'xhtml', 'xht',
# PHP scripts may execute arbitrary code on the server
'php', 'phtml', 'php3', 'php4', 'php5', 'phps',
# Other types that may be interpreted by some servers
'shtml', 'jhtml', 'pl', 'py', 'cgi',
# May contain harmful executables for Windows victims
'exe', 'scr', 'dll', 'msi', 'vbs', 'bat', 'com', 'pif', 'cmd', 'vxd', 'cpl' ]

Files with these extensions will never be allowed as uploads. An array of file extensions to blacklist. You should append to this array if you want to blacklist additional files.

$wgFileCacheDepth = 2

Depth of the subdirectory hierarchy to be created under $wgFileCacheDirectory. The subdirectories will be named based on the MD5 hash of the title. A value of 0 means all cache files will be put directly into the main file cache directory.

$wgFileCacheDirectory = false

Directory where the cached page will be saved. Defaults to "{$wgUploadDirectory}/cache".

$wgFileExtensions = [ 'png', 'gif', 'jpg', 'jpeg', 'webp' ]

This is the list of preferred extensions for uploading files. Uploading files with extensions not in this list will trigger a warning.

Warning
If you add any OpenOffice or Microsoft Office file formats here, such as odt or doc, and untrusted users are allowed to upload files, then your wiki will be vulnerable to cross-site request forgery (CSRF).
$wgFilterLogTypes
Initial value:
= [
'patrol' => true

Show/hide links on Special:Log will be shown for these log types.

This is associative array of log type => boolean "hide by default"

See $wgLogTypes for a list of available log types.

Example:
'move' => true,
'import' => false,
);

Will display show/hide links for the move and import logs. Move logs will be hidden by default unless the link is clicked. Import logs will be shown by default, and hidden when the link is clicked.

A message of the form log-show-hide-[type] should be added, and will be used for the link text.

$wgFixArabicUnicode = true

Set this to true to replace Arabic presentation forms with their standard forms in the U+0600-U+06FF block. This only works if $wgLanguageCode is set to "ar".

Note that pages with titles containing presentation forms will become inaccessible, run maintenance/cleanupTitles.php to fix this.

$wgFixDoubleRedirects = false

Fix double redirects after a page move. Tends to conflict with page move vandalism, use only on a private wiki.

$wgFixMalayalamUnicode = true

Set this to true to replace ZWJ-based chillu sequences in Malayalam text with their Unicode 5.1 equivalents. This only works if $wgLanguageCode is set to "ml". Note that some clients (even new clients as of 2010) do not support these characters.

If you enable this on an existing wiki, run maintenance/cleanupTitles.php to fix any ZWJ sequences in existing page titles.

$wgFooterIcons
Initial value:
= [
"copyright" => [
"copyright" => []

Abstract list of footer icons for skins in place of old copyrightico and poweredbyico code You can add new icons to the built in copyright or poweredby, or you can create a new block. Though note that you may need to add some custom css to get good styling of new blocks in monobook. vector and modern should work without any special css.

$wgFooterIcons itself is a key/value array. The key is the name of a block that the icons will be wrapped in. The final id varies by skin; Monobook and Vector will turn poweredby into f-poweredbyico while Modern turns it into mw_poweredby. The value is either key/value array of icons or a string. In the key/value array the key may or may not be used by the skin but it can be used to find the icon and unset it or change the icon if needed. This is useful for disabling icons that are set by extensions. The value should be either a string or an array. If it is a string it will be output directly as html, however some skins may choose to ignore it. An array is the preferred format for the icon, the following keys are used:

  • src: An absolute url to the image to use for the icon, this is recommended but not required, however some skins will ignore icons without an image
  • srcset: optional additional-resolution images; see HTML5 specs
  • url: The url to use in the a element around the text or icon, if not set an a element will not be outputted
  • alt: This is the text form of the icon, it will be displayed without an image in skins like Modern or if src is not set, and will otherwise be used as the alt="" for the image. This key is required.
  • width and height: If the icon specified by src is not of the standard size you can specify the size of image to use with these keys. Otherwise they will default to the standard 88x31.
    Todo:
    Reformat documentation.
$wgForcedRawSMaxage = 300

Default maximum age for raw CSS/JS accesses

300 seconds = 5 minutes.

$wgForceUIMsgAsContentMsg = []

When translating messages with wfMessage(), it is not always clear what should be considered UI messages and what should be content messages.

For example, for the English Wikipedia, there should be only one 'mainpage', so when getting the link for 'mainpage', we should treat it as site content and call ->inContentLanguage()->text(), but for rendering the text of the link, we call ->text(). The code behaves this way by default. However, sites like the Wikimedia Commons do offer different versions of 'mainpage' and the like for different languages. This array provides a way to override the default behavior.

Example:
To allow language-specific main page and community portal:
$wgForceUIMsgAsContentMsg = array( 'mainpage', 'portal-url' );
$wgForeignFileRepos = []
$wgForeignUploadTargets = []

Array of foreign file repo names (set in $wgForeignFileRepos above) that are allowable upload targets. These wikis must have some method of authentication (i.e. CentralAuth), and be CORS-enabled for this wiki.

Example: $wgForeignUploadTargets = array( 'shared' );

$wgGalleryOptions
Initial value:
= [
'imagesPerRow' => 0

Default parameters for the "<gallery>" tag

$wgGenerateThumbnailOnParse = true

Allow thumbnail rendering on page view. If this is false, a valid thumbnail URL is still output, but no file will be created at the target location. This may save some time if you have a thumb.php or 404 handler set up which is faster than the regular webserver(s).

$wgGitBin = '/usr/bin/git'

Fully specified path to git binary

$wgGitInfoCacheDirectory = false

Directory where GitInfo will look for pre-computed cache files. If false, $wgCacheDirectory/gitinfo will be used.

$wgGitRepositoryViewers
Initial value:
= [
'https://(?:[a-z0-9_]+@)?gerrit.wikimedia.org/r/(?:p/)?(.*)' =>
'https://phabricator.wikimedia.org/r/revision/%R;%H'

Map GIT repository URLs to viewer URLs to provide links in Special:Version

Key is a pattern passed to preg_match() and preg_replace(), without the delimiters (which are #) and must match the whole URL. The value is the replacement for the key (it can contain $1, etc.) h will be replaced by the short SHA-1 (7 first chars) and H by the full SHA-1 of the HEAD revision. r will be replaced with a URL-encoded version of $1. R will be replaced with $1 and no URL-encoding

Since
1.20
$wgGrammarForms = []

Some languages need different word forms, usually for different cases. Used in Language::convertGrammar().

Example:
$wgGrammarForms['en']['genitive']['car'] = 'car\'s';
$wgGrantPermissionGroups
Initial value:
= [
'basic' => 'hidden'
$wgGrantPermissions['delete']
Initial value:
= $wgGrantPermissions['editpage'] +
$wgGrantPermissions['viewdeleted']
$wgGroupPermissions = []

Permission keys given to users in each group.

This is an array where the keys are all groups and each value is an array of the format (right => boolean).

The second format is used to support per-namespace permissions. Note that this feature does not fully work for all permission types.

All users are implicitly in the '*' group including anonymous visitors; logged-in users are all implicitly in the 'user' group. These will be combined with the permissions of all groups that a given user is listed in in the user_groups table.

Note: Don't set $wgGroupPermissions = array(); unless you know what you're doing! This will wipe all permissions, and may mean that your users are unable to perform certain essential tasks or access new functionality when new permissions are introduced and default grants established.

Functionality to make pages inaccessible has not been extensively tested for security. Use at your own risk!

This replaces $wgWhitelistAccount and $wgWhitelistEdit

$wgGroupsAddToSelf = []

A map of group names that the user is in, to group names that those users are allowed to add or revoke.

Setting the list of groups to add or revoke to true is equivalent to "any group".

Example:
To allow sysops to add themselves to the "bot" group:
$wgGroupsAddToSelf = array( 'sysop' => array( 'bot' ) );
Example:
Implicit groups may be used for the source group, for instance:
$wgGroupsRemoveFromSelf = array( '*' => true );
This allows users in the '*' group (i.e. any user) to remove themselves from any group that they happen to be in.
$wgGroupsRemoveFromSelf = []
$wgHashedSharedUploadDirectory = true

Set the following to false especially if you have a set of files that need to be accessible by all wikis, and you do not want to use the hash (path/a/aa/) directory layout.

$wgHashedUploadDirectory = true

Set this to false if you do not want MediaWiki to divide your images directory into many subdirectories, for improved performance.

It's almost always good to leave this enabled. In previous versions of MediaWiki, some users set this to false to allow images to be added to the wiki by simply copying them into $wgUploadDirectory and then running maintenance/rebuildImages.php to register them in the database. This is no longer recommended, use maintenance/importImages.php instead.

Note
That this variable may be ignored if $wgLocalFileRepo is set.
Todo:
Deprecate the setting and ultimately remove it from Core.
$wgHiddenPrefs = []

An array of preferences to not show for the user

$wgHideIdentifiableRedirects = true

Should MediaWiki attempt to protect user's privacy when doing redirects? Keep this true if access counts to articles are made public.

$wgHideInterlanguageLinks = false

Hide interlanguage links from the sidebar

$wgHideUserContribLimit = 1000

The maximum number of edits a user can have and can still be hidden by users with the hideuser permission. This is limited for performance reason. Set to false to disable the limit.

Since
1.23
$wgHKDFAlgorithm = 'sha256'

Algorithm for hmac-based key derivation function (fast, cryptographically secure random numbers). See also: $wgHKDFSecret

Since
1.24
$wgHKDFSecret = false

Secret for hmac-based key derivation function (fast, cryptographically secure random numbers). This should be set in LocalSettings.php, otherwise wgSecretKey will be used. See also: $wgHKDFAlgorithm

Since
1.24
$wgHooks = []

Global list of hooks.

The key is one of the events made available by MediaWiki, you can find a description for most of them in docs/hooks.txt. The array is used internally by Hook:run().

The value can be one of:

  • A function name:
    $wgHooks['event_name'][] = $function;
  • A function with some data:
    $wgHooks['event_name'][] = array( $function, $data );
  • A an object method:
    $wgHooks['event_name'][] = array( $object, 'method' );
  • A closure:
    $wgHooks['event_name'][] = function ( $hookParam ) {
    // Handler code goes here.
    };
Warning
You should always append to an event array or you will end up deleting a previous registered hook.
Hook handlers should be registered at file scope. Registering handlers after file scope can lead to unexpected results due to caching.
$wgHTCPMulticastTTL = 1

HTCP multicast TTL.

See Also
$wgHTCPRouting
$wgHTCPRouting = []

Routing configuration for HTCP multicast purging. Add elements here to enable HTCP and determine which purges are sent where. If set to an empty array, HTCP is disabled.

Each key in this array is a regular expression to match against the purged URL, or an empty string to match all URLs. The purged URL is matched against the regexes in the order specified, and the first rule whose regex matches is used, all remaining rules will thus be ignored.

Example configuration to send purges for upload.wikimedia.org to one
multicast group and all other purges to another:
'|^https?://upload\.wikimedia\.org|' => array(
'host' => '239.128.0.113',
'port' => 4827,
),
'' => array(
'host' => '239.128.0.112',
'port' => 4827,
),
);

You can also pass an array of hosts to send purges too. This is useful when you have several multicast groups or unicast address that should receive a given purge. Multiple hosts support was introduced in MediaWiki 1.22.

Example of sending purges to multiple hosts:
'' => array(
// Purges to text caches using multicast
array( 'host' => '239.128.0.114', 'port' => '4827' ),
// Purges to a hardcoded list of caches
array( 'host' => '10.88.66.1', 'port' => '4827' ),
array( 'host' => '10.88.66.2', 'port' => '4827' ),
array( 'host' => '10.88.66.3', 'port' => '4827' ),
),
);
Since
1.22

$wgHTCPRouting replaces $wgHTCPMulticastRouting that was introduced in 1.20. For back compatibility purposes, whenever its array is empty $wgHTCPMutlicastRouting will be used as a fallback if it not null.

See Also
$wgHTCPMulticastTTL
$wgHtml5 = true

Previously used to determine if we should output an HTML5 doctype. This is no longer used as we always output HTML5 now. For compatibility with extensions that still check the value of this config it's value is now forced to true by Setup.php.

Deprecated:
since 1.22
$wgHtml5Version = null

Defines the value of the version attribute in the <html> tag, if any.

If your wiki uses RDFa, set it to the correct value for RDFa+HTML5. Correct current values are 'HTML+RDFa 1.0' or 'XHTML+RDFa 1.0'. See also http://www.w3.org/TR/rdfa-in-html/#document-conformance

Since
1.16
$wgHTMLFormAllowTableFormat = true

Temporary variable that allows HTMLForms to be rendered as tables. Table based layouts cause various issues when designing for mobile. This global allows skins or extensions a means to force non-table based rendering. Setting to false forces form components to always render as div elements.

Since
1.24
$wgHTTPConnectTimeout = 5e0

Timeout for connections done internally (in seconds) Only works for curl

$wgHTTPProxy = false

Proxy to use for CURL requests.

$wgHttpsPort = 443

Port where you have HTTPS running Supports HTTPS on non-standard ports

See Also
bug 65184
Since
1.24
$wgHTTPTimeout = 25

Timeout for HTTP requests done internally, in seconds.

$wgIgnoreImageErrors = false

If set, inline scaled images will still produce "<img>" tags ready for output instead of showing an error message.

This may be useful if errors are transitory, especially if the site is configured to automatically render thumbnails on request.

On the other hand, it may obscure error conditions from debugging. Enable the debug log or the 'thumbnail' log group to make sure errors are logged to a file for review.

$wgIllegalFileChars = ":"

These are additional characters that should be replaced with '-' in filenames

$wgImageLimits
Initial value:
= [
[ 320, 240 ],
[ 640, 480 ],
[ 800, 600 ],
[ 1024, 768 ],
[ 1280, 1024 ]
]

Limit images on image description pages to a user-selectable limit. In order to reduce disk usage, limits can only be selected from a list. The user preference is saved as an array offset in the database, by default the offset is set with $wgDefaultUserOptions['imagesize']. Make sure you change it if you alter the array (see bug 8858). This is the list of settings the user can choose from:

$wgImageMagickConvertCommand = '/usr/bin/convert'

The convert command shipped with ImageMagick

$wgImageMagickTempDir = false

Temporary directory used for ImageMagick. The directory must exist. Leave this set to false to let ImageMagick decide for itself.

$wgImgAuthDetails = false

Set this to true if you use img_auth and want the user to see details on why access failed.

$wgImgAuthUrlPathMap = []

Map of relative URL directories to match to internal mwstore:// base storage paths. For img_auth.php requests, everything after "img_auth.php/" is checked to see if starts with any of the prefixes defined here. The prefixes should not overlap. The prefix that matches has a corresponding storage path, which the rest of the URL is assumed to be relative to. The file at that path (or a 404) is send to the client.

Example: $wgImgAuthUrlPathMap['/timeline/'] = 'mwstore://local-fs/timeline-render/'; The above maps ".../img_auth.php/timeline/X" to "mwstore://local-fs/timeline-render/". The name "local-fs" should correspond by name to an entry in $wgFileBackends.

See Also
$wgFileBackends
$wgImplicitGroups = [ '*', 'user', 'autoconfirmed' ]

Implicit groups, aren't shown on Special:Listusers or somewhere else

$wgImportSources = []

List of interwiki prefixes for wikis we'll accept as sources for Special:Import and API action=import. Since complete page history can be imported, these should be 'trusted'.

This can either be a regular array, or an associative map specifying subprojects on the interwiki map of the target wiki, or a mix of the two, e.g.

'wikipedia' => array( 'cs', 'en', 'fr', 'zh' ),
'wikispecies',
'wikia' => array( 'animanga', 'brickipedia', 'desserts' ),
);

If you have a very complex import sources setup, you can lazy-load it using the ImportSources hook.

If a user has the 'import' permission but not the 'importupload' permission, they will only be able to run imports through this transwiki interface.

$wgImportTargetNamespace = null

Optional default target namespace for interwiki imports. Can use this to create an incoming "transwiki"-style queue. Set to numeric key, not the name.

Users may override this in the Special:Import dialog.

$wgIncludeLegacyJavaScript = false

Whether to ensure the mediawiki.legacy library is loaded before other modules.

Deprecated:
since 1.26: Always declare dependencies.
$wgInternalServer = false

Internal server name as known to CDN, if different.

Example:
$wgInternalServer = 'http://yourinternal.tld:8000';
$wgInterwikiExpiry = 10800

Expiry time for cache of interwiki table

$wgInterwikiFallbackSite = 'wiki'

Fallback site, if unable to resolve from cache

$wgInterwikiMagic = true

Treat language links as magic connectors, not inline links

$wgInterwikiScopes = 3

Specify number of domains to check for messages.

  • 1: Just wiki(db)-level
  • 2: wiki and global levels
  • 3: site levels
$wgInvalidateCacheOnLocalSettingsChange = true

Invalidate various caches when LocalSettings.php changes. This is equivalent to setting $wgCacheEpoch to the modification time of LocalSettings.php, as was previously done in the default LocalSettings.php file.

On high-traffic wikis, this should be set to false, to avoid the need to check the file modification time, and to avoid the performance impact of unnecessary cache invalidations.

$wgInvalidPasswordReset = true

Specifies if users should be sent to a password-reset form on login, if their password doesn't meet the requirements of User::isValidPassword().

Since
1.23
$wgInvalidUsernameCharacters = '@:'

Characters to prevent during new account creations. This is used in a regular expression character class during registration (regex metacharacters like / are escaped).

$wgJobClasses
Initial value:
= [
'refreshLinks' => 'RefreshLinksJob'

Maps jobs to their handling classes; extensions can add to this to provide custom jobs

$wgJobQueueAggregator
Initial value:
= [
'class' => 'JobQueueAggregatorNull'
]

Which aggregator to use for tracking which queues have jobs. These settings should be global to all wikis.

$wgJobRunRate = 1

Number of jobs to perform per request. May be less than one in which case jobs are performed probabalistically. If this is zero, jobs will not be done during ordinary apache requests. In this case, maintenance/runJobs.php should be run periodically.

$wgJobTypeConf
Initial value:
= [
'default' => [ 'class' => 'JobQueueDB'

Map of job types to configuration arrays. This determines which queue class and storage system is used for each job type. Job types that do not have explicit configuration will use the 'default' config. These settings should be global to all wikis.

$wgJobTypesExcludedFromDefaultQueue = [ 'AssembleUploadChunks', 'PublishStashedFile' ]

Jobs that must be explicitly requested, i.e. aren't run by job runners unless special flags are set. The values here are keys of $wgJobClasses.

These can be:

  • Very long-running jobs.
  • Jobs that you would never want to run as part of a page rendering request.
  • Jobs that you want to run on specialized machines ( like transcoding, or a particular machine on your cluster has 'outside' web access you could restrict uploadFromUrl ) These settings should be global to all wikis.
$wgJpegPixelFormat = 'yuv420'

At default setting of 'yuv420', JPEG thumbnails will use 4:2:0 chroma subsampling to reduce file size, at the cost of possible color fringing at sharp edges.

See https://en.wikipedia.org/wiki/Chroma_subsampling

Supported values: false - use scaling system's default (same as pre-1.27 behavior) 'yuv444' - luma and chroma at same resolution 'yuv422' - chroma at 1/2 resolution horizontally, full vertically 'yuv420' - chroma at 1/2 resolution in both dimensions

This setting is currently supported only for the ImageMagick backend; others may default to 4:2:0 or 4:4:4 or maintaining the source file's sampling in the thumbnail.

Since
1.27
$wgJpegTran = '/usr/bin/jpegtran'

used for lossless jpeg rotation

Since
1.21
$wgJsMimeType = null

Previously used as content type in HTML script tags. This is now ignored since HTML5 doesn't require a MIME type for script tags (javascript is the default). It was also previously used by RawAction to determine the ctype query parameter value that will result in a javascript response.

Deprecated:
since 1.22
$wgLangObjCacheSize = 10

Language cache size, or really how many languages can we handle simultaneously without degrading to crawl speed.

$wgLanguageCode = 'en'

Site language code. See languages/data/Names.php for languages supported by MediaWiki out of the box. Not all languages listed there have translations, see languages/messages/ for the list of languages with some localisation.

Warning: Don't use language codes listed in $wgDummyLanguageCodes like "no" for Norwegian (use "nb" instead), or things will break unexpectedly.

This defines the default interface language for all users, but users can change it in their preferences.

This also defines the language of pages in the wiki. The content is wrapped in a html element with lang=XX attribute. This behavior can be overridden via hooks, see Title::getPageLanguage.

$wgLanguageConverterCacheType = CACHE_ANYTHING

The cache type for storing language conversion tables, which are used when parsing certain text and interface messages.

For available types see $wgMainCacheType.

Since
1.20
$wgLBFactoryConf = [ 'class' => 'LBFactorySimple' ]

Load balancer factory configuration To set up a multi-master wiki farm, set the class here to something that can return a LoadBalancer with an appropriate master on a call to getMainLB(). The class identified here is responsible for reading $wgDBservers, $wgDBserver, etc., so overriding it may cause those globals to be ignored.

The LBFactoryMulti class is provided for this purpose, please see includes/db/LBFactoryMulti.php for configuration information.

$wgLegacyEncoding = false

Set this to eg 'ISO-8859-1' to perform character set conversion when loading old revisions not marked with "utf-8" flag. Use this when converting a wiki from MediaWiki 1.4 or earlier to UTF-8 without the burdensome mass conversion of old text data.

Note
This DOES NOT touch any fields other than old_text. Titles, comments, user names, etc still must be converted en masse in the database before continuing as a UTF-8 wiki.
$wgLegacyJavaScriptGlobals = true

Whether or not to assign configuration variables to the global window object.

If this is set to false, old code using deprecated variables will no longer work.

Example of legacy code:
{,js}
if ( window.wgRestrictionEdit ) { ... }
or:
{,js}
if ( wgIsArticle ) { ... }

Instead, one needs to use mw.config.

Example using mw.config global configuration:
{,js}
if ( mw.config.exists('wgRestrictionEdit') ) { ... }
or:
{,js}
if ( mw.config.get('wgIsArticle') ) { ... }
$wgLegacySchemaConversion = false

If set to true, the MediaWiki 1.4 to 1.5 schema conversion will create stub reference rows in the text table instead of copying the full text of all current entries from 'cur' to 'text'.

This will speed up the conversion step for large sites, but requires that the cur table be kept around for those revisions to remain viewable.

This option affects the updaters only. Any present cur stub revisions will be readable at runtime regardless of this setting.

$wgLegalTitleChars = " %!\"$&'()*,\\-.\\/0-9:;=?@A-Z\\\\^_`a-z~\\x80-\\xFF+"

Allowed title characters – regex character class Don't change this unless you know what you're doing

Problematic punctuation:

  • []{}|# Are needed for link syntax, never enable these
  • <> Causes problems with HTML escaping, don't use
  • % Enabled by default, minor problems with path to query rewrite rules, see below
  • + Enabled by default, but doesn't work with path to query rewrite rules, corrupted by apache
  • ? Enabled by default, but doesn't work with path to PATH_INFO rewrites

All three of these punctuation problems can be avoided by using an alias, instead of a rewrite rule of either variety.

The problem with % is that when using a path to query rewrite rule, URLs are double-unescaped: once by Apache's path conversion code, and again by PHP. So %253F, for example, becomes "?". Our code does not double-escape to compensate for this, indeed double escaping would break if the double-escaped title was passed in the query string rather than the path. This is a minor security issue because articles can be created such that they are hard to view or edit.

In some rare cases you may wish to remove + for compatibility with old links.

Theoretically 0x80-0x9F of ISO 8859-1 should be disallowed, but this breaks interlanguage links

$wgLinkHolderBatchSize = 1000

LinkHolderArray batch size For debugging

$wgLoadScript = false

The URL path to load.php.

Defaults to "{$wgScriptPath}/load.php".

Since
1.17
$wgLocalDatabases = []

Other wikis on this site, can be administered from a single developer account. Array numeric key => database name

$wgLocalFileRepo = false

File repository structures

$wgLocalFileRepo is a single repository structure, and $wgForeignFileRepos is an array of such structures. Each repository structure is an associative array of properties configuring the repository.

Properties required for all repos:

  • class The class name for the repository. May come from the core or an extension. The core repository classes are FileRepo, LocalRepo, ForeignDBRepo. FSRepo is also supported for backwards compatibility.
  • name A unique name for the repository (but $wgLocalFileRepo should be 'local'). The name should consist of alpha-numeric characters.
  • backend A file backend name (see $wgFileBackends).

For most core repos:

  • zones Associative array of zone names that each map to an array with: container : backend container name the zone is in directory : root path within container for the zone url : base URL to the root of the zone urlsByExt : map of file extension types to base URLs (useful for using a different cache for videos) Zones default to using "<repo name>-<zone name>" as the container name and default to using the container root as the zone's root directory. Nesting of zone locations within other zones should be avoided.
  • url Public zone URL. The 'zones' settings take precedence.
  • hashLevels The number of directory levels for hash-based division of files
  • thumbScriptUrl The URL for thumb.php (optional, not recommended)
  • transformVia404 Whether to skip media file transformation on parse and rely on a 404 handler instead.
  • initialCapital Equivalent to $wgCapitalLinks (or $wgCapitalLinkOverrides[NS_FILE], determines whether filenames implicitly start with a capital letter. The current implementation may give incorrect description page links when the local $wgCapitalLinks and initialCapital are mismatched.
  • pathDisclosureProtection May be 'paranoid' to remove all parameters from error messages, 'none' to leave the paths in unchanged, or 'simple' to replace paths with placeholders. Default for LocalRepo is 'simple'.
  • fileMode This allows wikis to set the file mode when uploading/moving files. Default is 0644.
  • directory The local filesystem directory where public files are stored. Not used for some remote repos.
  • thumbDir The base thumbnail directory. Defaults to "<directory>/thumb".
  • thumbUrl The base thumbnail URL. Defaults to "<url>/thumb".
  • isPrivate Set this if measures should always be taken to keep the files private. One should not trust this to assure that the files are not web readable; the server configuration should be done manually depending on the backend.

These settings describe a foreign MediaWiki installation. They are optional, and will be ignored for local repositories:

  • descBaseUrl URL of image description pages, e.g. https://en.wikipedia.org/wiki/File:
  • scriptDirUrl URL of the MediaWiki installation, equivalent to $wgScriptPath, e.g. https://en.wikipedia.org/w
  • scriptExtension Script extension of the MediaWiki installation, equivalent to $wgScriptExtension, e.g. ".php5". Defaults to ".php".
  • articleUrl Equivalent to $wgArticlePath, e.g. https://en.wikipedia.org/wiki/$1
  • fetchDescription Fetch the text of the remote file description page. Equivalent to $wgFetchCommonsDescriptions.
  • abbrvThreshold File names over this size will use the short form of thumbnail names. Short thumbnail names only have the width, parameters, and the extension.

ForeignDBRepo:

  • dbType, dbServer, dbUser, dbPassword, dbName, dbFlags equivalent to the corresponding member of $wgDBservers
  • tablePrefix Table prefix, the foreign wiki's $wgDBprefix
  • hasSharedCache True if the wiki's shared cache is accessible via the local $wgMemc

ForeignAPIRepo:

  • apibase Use for the foreign API's URL
  • apiThumbCacheExpiry How long to locally cache thumbs for

If you leave $wgLocalFileRepo set to false, Setup will fill in appropriate values. Otherwise, set $wgLocalFileRepo to a repository structure as described above. If you set $wgUseInstantCommons to true, it will add an entry for Commons. If you set $wgForeignFileRepos to an array of repository structures, those will be searched after the local file repo. Otherwise, you will only have access to local media files.

See Also
Setup.php for an example usage and default initialization.
$wgLocalInterwiki = false

The interwiki prefix of the current wiki, or false if it doesn't have one.

Deprecated:
since 1.23; use $wgLocalInterwikis instead
$wgLocalInterwikis = []

Array for multiple $wgLocalInterwiki values, in case there are several interwiki prefixes that point to the current wiki. If $wgLocalInterwiki is set, its value is prepended to this array, for backwards compatibility.

Note, recent changes feeds use only the first entry in this array (or $wgLocalInterwiki, if it is set). See $wgRCFeeds

$wgLocalisationCacheConf
Initial value:
= [
'class' => 'LocalisationCache'

Localisation cache configuration. Associative array with keys: class: The class to use. May be overridden by extensions.

store: The location to store cache data. May be 'files', 'array', 'db' or 'detect'. If set to "files", data will be in CDB files. If set to "db", data will be stored to the database. If set to "detect", files will be used if $wgCacheDirectory is set, otherwise the database will be used. "array" is an experimental option that uses PHP files that store static arrays.

storeClass: The class name for the underlying storage. If set to a class name, it overrides the "store" setting.

storeDirectory: If the store class puts its data in files, this is the directory it will use. If this is false, $wgCacheDirectory will be used.

manualRecache: Set this to true to disable cache updates on web requests. Use maintenance/rebuildLocalisationCache.php instead.

$wgLocalStylePath = false

The URL path of the skins directory. Should not point to an external domain. Defaults to "{$wgScriptPath}/skins".

Since
1.17
$wgLocaltimezone = null

Fake out the timezone that the server thinks it's in. This will be used for date display and not for what's stored in the DB. Leave to null to retain your server's OS-based timezone value.

This variable is currently used only for signature formatting and for local time/date parser variables ({{LOCALTIME}} etc.)

Timezones can be translated by editing MediaWiki messages of type timezone-nameinlowercase like timezone-utc.

A list of usable timezones can found at: http://php.net/manual/en/timezones.php

Examples:
$wgLocaltimezone = 'PST8PDT';
$wgLocaltimezone = 'Europe/Sweden';
$wgLocalTZoffset = null

Set an offset from UTC in minutes to use for the default timezone setting for anonymous users and new user accounts.

This setting is used for most date/time displays in the software, and is overridable in user preferences. It is not used for signature timestamps.

By default, this will be set to match $wgLocaltimezone.

$wgLocalVirtualHosts = []

Local virtual hosts.

This lists domains that are configured as virtual hosts on the same machine. If a request is to be made to a domain listed here, or any subdomain thereof, then no proxy will be used. Command-line scripts are not affected by this setting and will always use proxy if it is configured.

Since
1.25
$wgLockManagers = []

Array of configuration arrays for each lock manager. Each backend configuration has the following parameters:

  • 'name' : A unique name for the lock manager
  • 'class' : The lock manger class to use

See LockManager::__construct() for more details. Additional parameters are specific to the lock manager class used. These settings should be global to all wikis.

$wgLogActions = []

Lists the message key string for formatting individual events of each type and action when listed in the logs.

Extensions with custom log types may add to this array.

$wgLogActionsHandlers
Initial value:
= [
'block/block' => 'BlockLogFormatter'

The same as above, but here values are names of classes, not messages.

See Also
LogPage::actionText
LogFormatter
$wgLogAutopatrol = true

Log autopatrol actions to the log table

$wgLogExceptionBacktrace = true

If true, send the exception backtrace to the error log

$wgLogHeaders
Initial value:
= [
'' => 'alllogstext'

Lists the message key string for descriptive text to be shown at the top of each log type.

Extensions with custom log types may add to this array.

Since
1.19, if you follow the naming convention log-description-TYPE, where TYPE is your log type, yoy don't need to use this array.
$wgLoginLanguageSelector = false

Show a bar of language selection links in the user login and user registration forms; edit the "loginlanguagelinks" message to customise these.

$wgLogNames
Initial value:
= [
'' => 'all-logs-page'

Lists the message key string for each log type. The localized messages will be listed in the user interface.

Extensions with custom log types may add to this array.

Since
1.19, if you follow the naming convention log-name-TYPE, where TYPE is your log type, yoy don't need to use this array.
$wgLogo = false

The URL path of the wiki logo. The logo size should be 135x135 pixels. Defaults to "$wgResourceBasePath/resources/assets/wiki.png".

$wgLogoHD = false

Array with URL paths to HD versions of the wiki logo. The scaled logo size should be under 135x155 pixels. Only 1.5x and 2x versions are supported.

Example:
$wgLogoHD = array(
"1.5x" => "path/to/1.5x_version.png",
"2x" => "path/to/2x_version.png"
);
Since
1.25
$wgLogRestrictions
Initial value:
= [
'suppress' => 'suppressionlog'
]

This restricts log access to those who have a certain right Users without this will not see it in the option menu and can not view it Restricted logs are not added to recent changes Logs should remain non-transcludable Format: logtype => permissiontype

$wgLogTypes
Initial value:
= [
'',
'block',
'protect',
'rights',
'delete',
'upload',
'move',
'import',
'patrol',
'merge',
'suppress',
'tag',
'managetags',
'contentmodel',
]

The logging system has two levels: an event type, which describes the general category and can be viewed as a named subset of all logs; and an action, which is a specific kind of event that can exist in that log type.

$wgMainCacheType = CACHE_NONE

Main cache type. This should be a cache with fast access, but it may have limited space. By default, it is disabled, since the stock database cache is not fast enough to make it worthwhile.

The options are:

  • CACHE_ANYTHING: Use anything, as long as it works
  • CACHE_NONE: Do not cache
  • CACHE_DB: Store cache objects in the DB
  • CACHE_MEMCACHED: MemCached, must specify servers in $wgMemCachedServers
  • CACHE_ACCEL: APC, APCU, XCache or WinCache
  • (other): A string may be used which identifies a cache configuration in $wgObjectCaches.
See Also
$wgMessageCacheType, $wgParserCacheType
$wgMainStash = 'db-replicated'

Main object stash type. This should be a fast storage system for storing lightweight data like hit counters and user activity. Sites with multiple data-centers should have this use a store that replicates all writes. The store should have enough consistency for CAS operations to be usable. Reads outside of those needed for merge() may be eventually consistent.

The options are:

  • db: Store cache objects in the DB
  • (other): A string may be used which identifies a cache configuration in $wgObjectCaches
Since
1.26
$wgMainWANCache = false

Main Wide-Area-Network cache type. This should be a cache with fast access, but it may have limited space. By default, it is disabled, since the basic stock cache is not fast enough to make it worthwhile. For single data-center setups, this can simply be pointed to a cache in $wgWANObjectCaches that uses a local $wgObjectCaches cache with a relayer of type EventRelayerNull.

The options are:

  • false: Configure the cache using $wgMainCacheType, without using a relayer (only matters if there are multiple data-centers)
  • CACHE_NONE: Do not cache
  • (other): A string may be used which identifies a cache configuration in $wgWANObjectCaches
    Since
    1.26
$wgMangleFlashPolicy = true

When OutputHandler is used, mangle any output that contains <cross-domain-policy>. Without this, an attacker can send their own cross-domain policy unless it is prevented by the crossdomain.xml file at the domain root.

Since
1.25
$wgMaxAnimatedGifArea = 1.25e7

Force thumbnailing of animated GIFs above this size to a single frame instead of an animated thumbnail. As of MW 1.17 this limit is checked against the total size of all frames in the animation. It probably makes sense to keep this equal to $wgMaxImageArea.

$wgMaxArticleSize = 2048

Maximum article size in kilobytes

$wgMaxCredits = 0

Set this to the number of authors that you want to be credited below an article text. Set it to zero to hide the attribution block, and a negative number (like -1) to show all authors. Note that this will require 2-3 extra database hits, which can have a not insignificant impact on performance for large wikis.

$wgMaxImageArea = 1.25e7

The maximum number of pixels a source image can have if it is to be scaled down by a scaler that requires the full source image to be decompressed and stored in decompressed form, before the thumbnail is generated.

This provides a limit on memory usage for the decompression side of the image scaler. The limit is used when scaling PNGs with any of the built-in image scalers, such as ImageMagick or GD. It is ignored for JPEGs with ImageMagick, and when using the VipsScaler extension.

The default is 50 MB if decompressed to RGBA form, which corresponds to 12.5 million pixels or 3500x3500.

$wgMaximalPasswordLength = false

Specifies the maximal length of a user password (T64685).

It is not recommended to make this greater than the default, as it can allow DoS attacks by users setting really long passwords. In addition, this should not be lowered too much, as it enforces weak passwords.

Warning
Unlike other password settings, user with passwords greater than the maximum will not be able to log in.
Deprecated:
since 1.26, use $wgPasswordPolicy's MaximalPasswordLength.
$wgMaximumMovedPages = 100

Maximum number of pages to move at once when moving subpages with a page.

$wgMaxInterlacingAreas = []

Array of max pixel areas for interlacing per MIME type

Since
1.27
$wgMaxMsgCacheEntrySize = 10000

Maximum entry size in the message cache, in bytes

$wgMaxNameChars = 255

Maximum number of bytes in username. You want to run the maintenance script ./maintenance/checkUsernames.php once you have changed this value.

$wgMaxRedirectLinksRetrieved = 500

Maximum number of links to a redirect page listed on Special:Whatlinkshere/RedirectDestination

$wgMaxShellFileSize = 102400

Maximum file size created by shell processes under linux, in KB ImageMagick convert for example can be fairly hungry for scratch space

$wgMaxShellMemory = 307200

Maximum amount of virtual memory available to shell processes under linux, in KB.

$wgMaxShellTime = 180

Maximum CPU time in seconds for shell processes under Linux

$wgMaxShellWallClockTime = 180

Maximum wall clock time (i.e. real time, of the kind the clock on the wall would measure) in seconds for shell processes under Linux

$wgMaxSigChars = 255

Maximum number of Unicode characters in signature

$wgMaxUploadSize = 1024 * 1024 * 100

Max size for uploads, in bytes. If not set to an array, applies to all uploads. If set to an array, per upload type maximums can be set, using the file and url keys. If the * key is set this value will be used as maximum for non-specified types.

Example:
'*' => 250 * 1024,
'url' => 500 * 1024,
);
Sets the maximum for all uploads to 250 kB except for upload-by-url, which will have a maximum of 500 kB.
$wgMediaHandlers
Initial value:
= [
'image/jpeg' => 'JpegHandler'

Plugins for media file type handling. Each entry in the array maps a MIME type to a class name

$wgMemCachedDebug = false

If enabled, will send MemCached debugging information to $wgDebugLogFile

$wgMemCachedPersistent = false

Use persistent connections to MemCached, which are shared across multiple requests.

$wgMemCachedServers = [ '127.0.0.1:11211' ]

The list of MemCached servers and port numbers

$wgMemCachedTimeout = 500000

Read/write timeout for MemCached server communication, in microseconds.

$wgMemoryLimit = "50M"

The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to raise PHP's memory limit if it's below this amount.

$wgMessageCacheType = CACHE_ANYTHING

The cache type for storing the contents of the MediaWiki namespace. This cache is used for a small amount of data which is expensive to regenerate.

For available types see $wgMainCacheType.

$wgMessagesDirs = []

Extension messages directories.

Associative array mapping extension name to the path of the directory where message files can be found. The message files are expected to be JSON files named for their language code, e.g. en.json, de.json, etc. Extensions with messages in multiple places may specify an array of message directories.

Message directories in core should be added to LocalisationCache::getMessagesDirs()

Simple example:
$wgMessagesDirs['Example'] = __DIR__ . '/i18n';
Complex example:
$wgMessagesDirs['Example'] = array(
__DIR__ . '/lib/ve/i18n',
__DIR__ . '/lib/oojs-ui/i18n',
__DIR__ . '/i18n',
)
Since
1.23
$wgMetaNamespace = false

Name of the project namespace. If left set to false, $wgSitename will be used instead.

$wgMetaNamespaceTalk = false

Name of the project talk namespace.

Normally you can ignore this and it will be something like $wgMetaNamespace . "_talk". In some languages, you may want to set this manually for grammatical reasons.

$wgMimeDetectorCommand = null

Sets an external MIME detector program. The command must print only the MIME type to standard output. The name of the file to process will be appended to the command given here. If not set or NULL, PHP's fileinfo extension will be used if available.

Example:
#$wgMimeDetectorCommand = "file -bi"; # use external MIME detector (Linux)
$wgMimeInfoFile = 'includes/mime.info'

Sets the MIME type info file to use by MimeMagic.php. Set to null, to use built-in defaults only.

$wgMimeType = 'text/html'

The default Content-Type header.

$wgMimeTypeBlacklist
Initial value:
= [
# HTML may contain cookie-stealing JavaScript and web bugs
'text/html', 'text/javascript', 'text/x-javascript', 'application/x-shellscript',
# PHP scripts may execute arbitrary code on the server
'application/x-php', 'text/x-php',
# Other types that may be interpreted by some servers
'text/x-python', 'text/x-perl', 'text/x-bash', 'text/x-sh', 'text/x-csh',
# Client-side hazards on Internet Explorer
'text/scriptlet', 'application/x-msdownload',
# Windows metafile, client-side vulnerability on some systems
'application/x-msmetafile',
]

Files with these MIME types will never be allowed as uploads if $wgVerifyMimeType is enabled.

$wgMimeTypeFile = 'includes/mime.types'

Sets the MIME type definition file to use by MimeMagic.php. Set to null, to use built-in defaults only. example: $wgMimeTypeFile = '/etc/mime.types';

$wgMinimalPasswordLength = false

Specifies the minimal length of a user password. If set to 0, empty pass- words are allowed.

Deprecated:
since 1.26, use $wgPasswordPolicy's MinimalPasswordLength.
$wgMinUploadChunkSize = 1024

Minimum upload chunk size, in bytes. When using chunked upload, non-final chunks smaller than this will be rejected. May be reduced based on the 'upload_max_filesize' or 'post_max_size' PHP settings.

Since
1.26
$wgMiserMode = false

Disable database-intensive features

$wgMsgCacheExpiry = 86400

Expiry time for the message cache key

array $wgMWLoggerDefaultSpi
Initial value:
= [
'class' => '\\MediaWiki\\Logger\\LegacySpi'

Default service provider for creating Psr instances.

The value should be an array suitable for use with ObjectFactory::getObjectFromSpec(). The created object is expected to implement the MediaWiki interface. See ObjectFactory for additional details.

Alternately the MediaWiki::registerProvider method can be called to inject an MediaWiki instance into the LoggerFactory and bypass the use of this configuration variable entirely.

To completely disable logging:
$wgMWLoggerDefaultSpi = array( 'class' => '\\MediaWiki\\Logger\\NullSpi' );
Since
1.25
See Also
MwLogger
$wgNamespaceAliases = []

Namespace aliases.

These are alternate names for the primary localised namespace names, which are defined by $wgExtraNamespaces and the language file. If a page is requested with such a prefix, the request will be redirected to the primary name.

Set this to a map from namespace names to IDs.

Example:
'Wikipedian' => NS_USER,
'Help' => 100,
);
$wgNamespaceContentModels = []

Associative array mapping namespace IDs to the name of the content model pages in that namespace should have by default (use the CONTENT_MODEL_XXX constants). If no special content type is defined for a given namespace, pages in that namespace will use the CONTENT_MODEL_WIKITEXT (except for the special case of JS and CS pages).

Since
1.21
$wgNamespaceProtection = []

Set the minimum permissions required to edit pages in each namespace. If you list more than one permission, a user must have all of them to edit pages in that namespace.

Note
NS_MEDIAWIKI is implicitly restricted to 'editinterface'.
$wgNamespaceRobotPolicies = []

Robot policies per namespaces. The default policy is given above, the array is made of namespace constants as defined in includes/Defines.php. You can- not specify a different default policy for NS_SPECIAL: it is always noindex, nofollow. This is because a number of special pages (e.g., ListPages) have many permutations of options that display the same data under redundant URLs, so search engine spiders risk getting lost in a maze of twisty special pages, all alike, and never reaching your actual content.

Example:
$wgNamespaceRobotPolicies = array( NS_TALK => 'noindex' );
$wgNamespacesToBeSearchedDefault
Initial value:
= [
NS_MAIN => true
const NS_MAIN
Definition: Defines.php:70

List of namespaces which are searched by default.

Example:
$wgNamespacesWithSubpages
Initial value:
= [
NS_TALK => true

Which namespaces should support subpages? See Language.php for a list of namespaces.

$wgNewPasswordExpiry = 3600 * 24 * 7

The time, in seconds, when an emailed temporary password expires.

$wgNewUserLog = true

Maintain a log of newusers at Log/newusers?

$wgNoFollowDomainExceptions = [ 'mediawiki.org' ]

If this is set to an array of domains, external links to these domain names (or any subdomains) will not be set to rel="nofollow" regardless of the value of $wgNoFollowLinks. For instance:

$wgNoFollowDomainExceptions = array( 'en.wikipedia.org', 'wiktionary.org', 'mediawiki.org' );

This would add rel="nofollow" to links to de.wikipedia.org, but not en.wikipedia.org, wiktionary.org, en.wiktionary.org, us.en.wikipedia.org, etc.

Defaults to mediawiki.org for the links included in the software by default.

$wgNoFollowLinks = true

If true, external URL links in wiki text will be given the rel="nofollow" attribute as a hint to search engines that they should not be followed for ranking purposes as they are user-supplied and thus subject to spamming.

$wgNoFollowNsExceptions = []

Namespaces in which $wgNoFollowLinks doesn't apply. See Language.php for a list of namespaces.

$wgNonincludableNamespaces = []

Pages in namespaces in this array can not be used as templates.

Elements MUST be numeric namespace ids, you can safely use the MediaWiki namespaces constants (NS_USER, NS_MAIN...).

Among other things, this may be useful to enforce read-restrictions which may otherwise be bypassed by using the template mechanism.

$wgNoReplyAddress = false

Reply-To address for e-mail notifications.

Defaults to $wgPasswordSender.

$wgObjectCaches
Initial value:
= [
CACHE_NONE => [ 'class' => 'EmptyBagOStuff'

Advanced object cache configuration.

Use this to define the class names and constructor parameters which are used for the various cache types. Custom cache types may be defined here and referenced from $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType, or $wgLanguageConverterCacheType.

The format is an associative array where the key is a cache identifier, and the value is an associative array of parameters. The "class" parameter is the class name which will be used. Alternatively, a "factory" parameter may be given, giving a callable function which will generate a suitable cache object.

$wgObjectCacheSessionExpiry = 3600

The expiry time to use for session storage, in seconds.

$wgOpenSearchDefaultLimit = 10

Integer defining default number of entries to show on OpenSearch call.

$wgOpenSearchDescriptionLength = 100

Minimum length of extract in . Actual extracts will last until the end of sentence.

$wgOpenSearchTemplate = false

Template for OpenSearch suggestions, defaults to API action=opensearch

Sites with heavy load would typically have these point to a custom PHP wrapper to avoid firing up mediawiki for every keystroke

Placeholders: {searchTerms}

Deprecated:
since 1.25 Use $wgOpenSearchTemplates['application/x-suggestions+json'] instead
$wgOpenSearchTemplates
Initial value:
= [
'application/x-suggestions+json' => false

Templates for OpenSearch suggestions, defaults to API action=opensearch

Sites with heavy load would typically have these point to a custom PHP wrapper to avoid firing up mediawiki for every keystroke

Placeholders: {searchTerms}

$wgOverrideHostname = false

Override server hostname detection with a hardcoded value. Should be a string, default false.

Since
1.20
$wgOverrideSiteFeed = []

Override the site's default RSS/ATOM feed for recentchanges that appears on every page. Some sites might have a different feed they'd like to promote instead of the RC feed (maybe like a "Recent New Articles" or "Breaking news" one). Should be a format as key (either 'rss' or 'atom') and an URL to the feed as value.

Example:
Configure the 'atom' feed to http://example.com/somefeed.xml
$wgSiteFeed['atom'] = "http://example.com/somefeed.xml";
$wgPageInfoTransclusionLimit = 50

InfoAction retrieves a list of transclusion links (both to and from). This number puts a limit on that query in the case of highly transcluded templates.

$wgPagePropLinkInvalidations
Initial value:
= [
'hiddencat' => 'categorylinks'

Page property link table invalidation lists. When a page property changes, this may require other link tables to be updated (eg adding HIDDENCAT means the hiddencat tracking category will have been added, so the categorylinks table needs to be rebuilt). This array can be added to by extensions.

$wgPagePropsHaveSortkey = true

Whether the page_props table has a pp_sortkey column. Set to false in case the respective database schema change was not applied.

Since
1.23
$wgParserCacheExpireTime = 86400

The expiry time for the parser cache, in seconds. The default is 86400 (one day).

$wgParserCacheType = CACHE_ANYTHING

The cache type for storing article HTML. This is used to store data which is expensive to regenerate, and benefits from having plenty of storage space.

For available types see $wgMainCacheType.

array $mOutputHooks Hook tags as per ParserOutput::$wgParserOutputHooks = []

Parser output hooks. This is an associative array where the key is an extension-defined tag (typically the extension name), and the value is a PHP callback. These will be called as an OutputPageParserOutput hook, if the relevant tag has been registered with the parser output object.

Registration is done with $pout->addOutputHook( $tag, $data ).

The callback has the form:

function outputHook( $outputPage, $parserOutput, $data ) { ... }
$wgParserTestFiles
Initial value:
= [
"$IP/tests/parser/parserTests.txt",
"$IP/tests/parser/extraParserTests.txt"
]

Parser test suite files to be run by parserTests.php when no specific filename is passed to it.

Extensions may add their own tests to this array, or site-local tests may be added via LocalSettings.php

Use full paths.

$wgPasswordAttemptThrottle
Initial value:
= [
[ 'count' => 5, 'seconds' => 300 ],
[ 'count' => 150, 'seconds' => 60*60*48 ],
]

Limit password attempts to X attempts per Y seconds per IP per account.

Value is an array of arrays. Each sub-array must have a key for count (ie count of how many attempts before throttle) and a key for seconds. If the key 'allIPs' (case sensitive) is present, then the limit is just per account instead of per IP per account.

Since
1.27 allIps support and multiple limits added in 1.27. Prior to 1.27 this only supported having a single throttle.
Warning
Requires $wgMainCacheType to be enabled
$wgPasswordConfig
Initial value:
= [
'A' => [
'class' => 'MWOldPassword'

Configuration for built-in password types. Maps the password type to an array of options. The 'class' option is the Password class to use. All other options are class-dependent.

An advanced example:

$wgPasswordConfig['bcrypt-peppered'] = array(
'class' => 'EncryptedPassword',
'underlying' => 'bcrypt',
'secrets' => array(),
'cipher' => MCRYPT_RIJNDAEL_256,
'mode' => MCRYPT_MODE_CBC,
'cost' => 5,
);
Since
1.24
$wgPasswordDefault = 'pbkdf2'

Default password type to use when hashing user passwords

Since
1.24
$wgPasswordExpirationDays = false

The number of days that a user's password is good for. After this number of days, the user will be asked to reset their password. Set to false to disable password expiration.

$wgPasswordExpireGrace = 3600 * 24 * 7

If a user's password is expired, the number of seconds when they can still login, and cancel their password change, but are sent to the password change form on each login.

$wgPasswordPolicy
Initial value:
= [
'policies' => [
'bureaucrat' => [
'MinimalPasswordLength' => 8

Password policy for local wiki users. A user's effective policy is the superset of all policy statements from the policies for the groups where the user is a member. If more than one group policy include the same policy statement, the value is the max() of the values. Note true > false. The 'default' policy group is required, and serves as the minimum policy for all users. New statements can be added by appending to $wgPasswordPolicy['checks']. Statements:

  • MinimalPasswordLength - minimum length a user can set
  • MinimumPasswordLengthToLogin - passwords shorter than this will not be allowed to login, regardless if it is correct.
  • MaximalPasswordLength - maximum length password a user is allowed to attempt. Prevents DoS attacks with pbkdf2.
  • PasswordCannotMatchUsername - Password cannot match username to
  • PasswordCannotMatchBlacklist - Username/password combination cannot match a specific, hardcoded blacklist.
  • PasswordCannotBePopular - Blacklist passwords which are known to be commonly chosen. Set to integer n to ban the top n passwords. If you want to ban all common passwords on file, use the PHP_INT_MAX constant.
    Since
    1.26
$wgPasswordReminderResendTime = 24

Minimum time, in hours, which must elapse between password reminder emails for a given account. This is to prevent abuse by mail flooding.

$wgPasswordResetRoutes
Initial value:
= [
'username' => true

Whether to allow password resets ("enter some identifying data, and we'll send an email with a temporary password you can use to get back into the account") identified by various bits of data. Setting all of these to false (or the whole variable to false) has the effect of disabling password resets entirely

$wgPasswordSalt = true

For compatibility with old installations set to false

Deprecated:
since 1.24 will be removed in future
$wgPasswordSender = false

Sender email address for e-mail notifications.

The address we use as sender when a user requests a password reminder.

Defaults to "apache@$wgServerName".

$wgPasswordSenderName = 'MediaWiki Mail'

Sender name for e-mail notifications.

Deprecated:
since 1.23; use the system message 'emailsender' instead.
$wgPhpCli = '/usr/bin/php'

Executable path of the PHP cli binary (php/php5). Should be set up on install.

$wgPoolCounterConf = null

Configuration for processing pool control, for use in high-traffic wikis. An implementation is provided in the PoolCounter extension.

This configuration array maps pool types to an associative array. The only defined key in the associative array is "class", which gives the class name. The remaining elements are passed through to the class as constructor parameters.

Example:
$wgPoolCounterConf = array( 'ArticleView' => array(
'class' => 'PoolCounter_Client',
'timeout' => 15, // wait timeout in seconds
'workers' => 5, // maximum number of active threads in each pool
'maxqueue' => 50, // maximum number of total threads in each pool
... any extension-specific options...
);
$wgPreprocessorCacheThreshold = 1000

Preprocessor caching threshold Setting it to 'false' will disable the preprocessor cache.

$wgPreviewOnOpenNamespaces
Initial value:
= [
NS_CATEGORY => true
]

Which namespaces have special treatment where they should be preview-on-open Internally only Category: pages apply, but using this extensions (e.g. Semantic MediaWiki) can specify namespaces of pages they have special treatment for

$wgProfileLimit = 0.0

Only record profiling info for pages that took longer than this

Deprecated:
since 1.25: set $wgProfiler['threshold'] instead.
$wgProfileOnly = false

Don't put non-profiling info into log file

Deprecated:
since 1.23, set the log file in $wgDebugLogGroups['profileoutput'] instead.
$wgProxyList = []

Big list of banned IP addresses.

This can have the following formats:

  • An array of addresses, either in the values or the keys (for backward compatibility)
  • A string, in that case this is the path to a file containing the list of IP addresses, one per line
$wgProxyWhitelist = []

Proxy whitelist, list of addresses that are assumed to be non-proxy despite what the other methods might say.

$wgPutIPinRC = true

Log IP addresses in the recentchanges table; can be accessed only by extensions (e.g. CheckUser) or a DB admin Used for retroactive autoblocks

$wgQueryCacheLimit = 1000

Number of rows to cache in 'querycache' table when miser mode is on

$wgQueryPageDefaultLimit = 50

Integer defining default number of entries to show on special pages which are query-pages such as Special:Whatlinkshere.

$wgRateLimits
Initial value:
= [
'edit' => [
'ip' => [ 8, 60 ]

Simple rate limiter options to brake edit floods.

Maximum number actions allowed in the given number of seconds; after that the violating client receives HTTP 500 error pages until the period elapses.

Example:
To set a generic maximum of 4 hits in 60 seconds:
$wgRateLimits = array( 4, 60 );
Example:
You could also limit per action and then type of users.
$wgRateLimits = array(
'edit' => array(
'anon' => array( x, y ), // any and all anonymous edits (aggregate)
'user' => array( x, y ), // each logged-in user
'newbie' => array( x, y ), // each new autoconfirmed accounts; overrides 'user'
'ip' => array( x, y ), // each anon and recent account
'subnet' => array( x, y ), // ... within a /24 subnet in IPv4 or /64 in IPv6
)
)
Warning
Requires that $wgMainCacheType is set to something persistent
$wgRateLimitsExcludedIPs = []

Array of IPs which should be excluded from rate limits. This may be useful for whitelisting NAT gateways for conferences, etc.

$wgRawHtml = false

Allow raw, unchecked HTML in "<html>...</html>" sections. THIS IS VERY DANGEROUS on a publicly editable site, so USE wgGroupPermissions TO RESTRICT EDITING to only those that you trust

$wgRCChangedSizeThreshold = 500

If the difference between the character counts of the text before and after the edit is below that value, the value will be highlighted on the RC page.

$wgRCEngines
Initial value:
= [
'redis' => 'RedisPubSubFeedEngine'

Used by RecentChange::getEngine to find the correct engine to use for a given URI scheme. Keys are scheme names, values are names of engine classes.

$wgRCFilterByAge = false

Filter $wgRCLinkDays by $wgRCMaxAge to avoid showing links for numbers higher than what will be stored. Note that this is disabled by default because we sometimes do have RC data which is beyond the limit for some reason, and some users may use the high numbers to display that data which is still there.

$wgRCLinkDays = [ 1, 3, 7, 14, 30 ]

List of Days options to list in the Special:Recentchanges and Special:Recentchangeslinked pages.

$wgRCLinkLimits = [ 50, 100, 250, 500 ]

List of Limits options to list in the Special:Recentchanges and Special:Recentchangeslinked pages.

$wgRCMaxAge = 90 * 24 * 3600

Recentchanges items are periodically purged; entries older than this many seconds will go. Default: 90 days = about three months

$wgRCShowChangedSize = true

Show the amount of changed characters in recent changes

$wgRCShowWatchingUsers = false

Show watching users in recent changes, watchlist and page history views

$wgRCWatchCategoryMembership = false

Treat category membership changes as a RecentChange. Changes are mentioned in RC for page actions as follows:

  • creation: pages created with categories are mentioned
  • edit: category additions/removals to existing pages are mentioned
  • move: nothing is mentioned (unless templates used depend on the title)
  • deletion: nothing is mentioned
  • undeletion: nothing is mentioned
Since
1.27
$wgReadOnly = null

Set this to a string to put the wiki into read-only mode. The text will be used as an explanation to users.

This prevents most write operations via the web interface. Cache updates may still be possible. To prevent database writes completely, use the read_only option in MySQL.

$wgReadOnlyFile = false

If this lock file exists (size > 0), the wiki will be forced into read-only mode. Its contents will be shown to users as part of the read-only warning message.

Will default to "{$wgUploadDirectory}/lock_yBgMBwiR" in Setup.php

$wgReauthenticateTime
Initial value:
= [
'default' => 300
$wgRecentChangesFlags
Initial value:
= [
'newpage' => [
'letter' => 'newpageletter'

Flags (letter symbols) shown in recent changes and watchlist to indicate certain types of edits.

To register a new one:

$wgRecentChangesFlags['flag'] => array(
// message for the letter displayed next to rows on changes lists
'letter' => 'letter-msg',
// message for the tooltip of the letter
'title' => 'tooltip-msg',
// optional (defaults to 'tooltip-msg'), message to use in the legend box
'legend' => 'legend-msg',
// optional (defaults to 'flag'), CSS class to put on changes lists rows
'class' => 'css-class',
// optional (defaults to 'any'), how top-level flag is determined. 'any'
// will set the top-level flag if any line contains the flag, 'all' will
// only be set if all lines contain the flag.
'grouping' => 'any',
);
Since
1.22
$wgRedirectOnLogin = null

Allow redirection to another page when a user logs in. To enable, set to a string like 'Main Page'

$wgRedirectSources = false

If local interwikis are set up which allow redirects, set this regexp to restrict URLs which will be displayed as 'redirected from' links.

Example:
It might look something like this:
$wgRedirectSources = '!^https?://[a-z-]+\.wikipedia\.org/!';

Leave at false to avoid displaying any incoming redirect markers. This does not affect intra-wiki redirects, which don't change the URL.

$wgReferrerPolicy = false

Value for the referrer policy meta tag. One of 'never', 'default', 'origin', 'always'. Setting it to false just prevents the meta tag from being output. See http://www.w3.org/TR/referrer-policy/ for details.

Since
1.25
$wgRegisterInternalExternals = false

By default MediaWiki does not register links pointing to same server in externallinks dataset, use this value to override:

$wgRemoveCredentialsBlacklist
Initial value:
= [
\MediaWiki\Auth\PasswordAuthenticationRequest::class,
]
$wgRemoveGroups = []
See Also
$wgAddGroups
$wgRenderHashAppend = ''

Append a configured value to the parser cache and the sitenotice key so that they can be kept separate for some class of activity.

$wgRepositoryBaseUrl = "https://commons.wikimedia.org/wiki/File:"

Base URL for a repository wiki. Leave this blank if uploads are just stored in a shared directory and not meant to be accessible through a separate wiki. Otherwise the image description pages on the local wiki will link to the image description page on this wiki.

Please specify the namespace, as in the example below.

$wgReservedUsernames
Initial value:
= [
'MediaWiki default',
'Conversion script',
'Maintenance script',
'Template namespace initialisation script',
'ScriptImporter',
'msg:double-redirect-fixer',
'msg:usermessage-editor',
'msg:proxyblocker',
'msg:spambot_username',
'msg:autochange-username',
]

Array of usernames which may not be registered or logged in from Maintenance scripts can still use these

$wgResourceBasePath = null

The default 'remoteBasePath' value for instances of ResourceLoaderFileModule. Defaults to $wgScriptPath.

$wgResourceLoaderDebug = false

The default debug mode (on/off) for of ResourceLoader requests.

This will still be overridden when the debug URL parameter is used.

$wgResourceLoaderLESSImportPaths
Initial value:
= [
"$IP/resources/src/mediawiki.less/",
]

Default import paths for LESS modules. LESS files referenced in statements will be looked up here first, and relative to the importing file second. To avoid collisions, it's important for the LESS files in these directories to have a common, predictable file name prefix.

Extensions need not (and should not) register paths in $wgResourceLoaderLESSImportPaths. The import path includes the path of the currently compiling LESS file, which allows each extension to freely import files from its own tree.

Since
1.22
$wgResourceLoaderLESSVars
Initial value:
= [
'deviceWidthTablet' => '720px'

Global LESS variables. An associative array binding variable names to LESS code snippets representing their values.

Adding an item here is equivalent to writing @variable: value; at the beginning of all your .less files, with all the consequences. In particular, string values must be escaped and quoted.

Changes to LESS variables do not trigger cache invalidation.

If the LESS variables need to be dynamic, you can use the ResourceLoaderGetLessVars hook (since 1.25).

Example:
'baseFontSize' => '1em',
'smallFontSize' => '0.75em',
'WikimediaBlue' => '#006699',
);
Since
1.22
$wgResourceLoaderMaxage
Initial value:
= [
'versioned' => [
'server' => 30 * 24 * 60 * 60

Maximum time in seconds to cache resources served by ResourceLoader. Used to set last modified headers (max-age/s-maxage).

Following options to distinguish:

  • versioned: Used for modules with a version, because changing version numbers causes cache misses. This normally has a long expiry time.
  • unversioned: Used for modules without a version to propagate changes quickly to clients. Also used for modules with errors to recover quickly. This normally has a short expiry time.

Expiry time for the options to distinguish:

  • server: Squid/Varnish but also any other public proxy cache between the client and MediaWiki.
  • client: On the client side (e.g. in the browser cache).
$wgResourceLoaderMaxQueryLength = false

If set to a positive number, ResourceLoader will not generate URLs whose query string is more than this many characters long, and will instead use multiple requests with shorter query strings. This degrades performance, but may be needed if your web server has a low (less than, say 1024) query string length limit or a low value for suhosin.get.max_value_length that you can't increase.

If set to a negative number, ResourceLoader will assume there is no query string length limit.

Defaults to a value based on php configuration.

$wgResourceLoaderMinifierMaxLineLength = 1000

Maximum line length when minifying JavaScript. This is not a hard maximum: the minifier will try not to produce lines longer than this, but may be forced to do so in certain cases.

Deprecated:
since 1.27: Always 1,000; no longer configurable.
$wgResourceLoaderMinifierStatementsOnOwnLine = false

Put each statement on its own line when minifying JavaScript. This makes debugging in non-debug mode a bit easier.

Deprecated:
since 1.27: Always false; no longer configurable.
$wgResourceLoaderSources = []

Extensions should register foreign module sources here. 'local' is a built-in source that is not in this array, but defined by ResourceLoader::__construct() so that it cannot be unset.

Example:
$wgResourceLoaderSources['foo'] = 'http://example.org/w/load.php';
$wgResourceLoaderStorageEnabled = false

Whether ResourceLoader should attempt to persist modules in localStorage on browsers that support the Web Storage API.

Since
1.23 - Client-side module persistence is experimental. Exercise care.
$wgResourceLoaderStorageVersion = 1

Cache version for client-side ResourceLoader module storage. You can trigger invalidation of the contents of the module store by incrementing this value.

Since
1.23
$wgResourceLoaderValidateJS = true

If set to true, JavaScript modules loaded from wiki pages will be parsed prior to minification to validate it.

Parse errors will result in a JS exception being thrown during module load, which avoids breaking other modules loaded in the same request.

$wgResourceLoaderValidateStaticJS = false

If set to true, statically-sourced (file-backed) JavaScript resources will be parsed for validity before being bundled up into ResourceLoader modules.

This can be helpful for development by providing better error messages in default (non-debug) mode, but JavaScript parsing is slow and memory hungry and may fail on large pre-bundled frameworks.

$wgResourceModules = []

Client-side resource modules.

Extensions should add their ResourceLoader module definitions to the $wgResourceModules variable.

Example:
$wgResourceModules['ext.myExtension'] = array(
'scripts' => 'myExtension.js',
'styles' => 'myExtension.css',
'dependencies' => array( 'jquery.cookie', 'jquery.tabIndex' ),
'localBasePath' => __DIR__,
'remoteExtPath' => 'MyExtension',
);
$wgResourceModuleSkinStyles = []

Skin-specific styles for resource modules.

These are later added to the 'skinStyles' list of the existing module. The 'styles' list can not be modified or disabled.

For example, here is a module "bar" and how skin Foo would provide additional styles for it.

Example:
$wgResourceModules['bar'] = array(
'scripts' => 'resources/bar/bar.js',
'styles' => 'resources/bar/main.css',
);
'bar' => 'skins/Foo/bar.css',
);

This is mostly equivalent to:

Equivalent:
$wgResourceModules['bar'] = array(
'scripts' => 'resources/bar/bar.js',
'styles' => 'resources/bar/main.css',
'skinStyles' => array(
'foo' => skins/Foo/bar.css',
),
);

If the module already defines its own entry in skinStyles for a given skin, then $wgResourceModuleSkinStyles is ignored.

If a module defines a `skinStyles['default']the skin may want to extend that instead of replacing them. This can be done using the+` prefix.

Example:
$wgResourceModules['bar'] = array(
'scripts' => 'resources/bar/bar.js',
'styles' => 'resources/bar/basic.css',
'skinStyles' => array(
'default' => 'resources/bar/additional.css',
),
);
// Note the '+' character:
'+bar' => 'skins/Foo/bar.css',
);

This is mostly equivalent to:

Equivalent:
$wgResourceModules['bar'] = array(
'scripts' => 'resources/bar/bar.js',
'styles' => 'resources/bar/basic.css',
'skinStyles' => array(
'default' => 'resources/bar/additional.css',
'foo' => array(
'resources/bar/additional.css',
'skins/Foo/bar.css',
),
),
);

In other words, as a module author, use the styles list for stylesheets that may not be disabled by a skin. To provide default styles that may be extended or replaced, use `skinStyles['default']`.

As with $wgResourceModules, paths default to being relative to the MediaWiki root. You should always provide a localBasePath and remoteBasePath (or remoteExtPath/remoteSkinPath).

Example:
'bar' => 'bar.css',
'quux' => 'quux.css',
'remoteSkinPath' => 'Foo',
'localBasePath' => __DIR__,
);
$wgResponsiveImages = true

Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities.

This means a 320x240 use of an image on the wiki will also generate 480x360 and 640x480 thumbnails, output via the srcset attribute.

On older browsers, a JavaScript polyfill switches the appropriate images in after loading the original low-resolution versions depending on the reported window.devicePixelRatio. The polyfill can be found in the jquery.hidpi module.

$wgRestrictDisplayTitle = true

For consistency, restrict DISPLAYTITLE to text that normalizes to the same canonical DB key. Also disallow some inline CSS rules like display: none; which can cause the text to be hidden or unselectable.

$wgRestrictionLevels = [ '', 'autoconfirmed', 'sysop' ]

Rights which can be required for each protection level (via action=protect)

You can add a new protection level that requires a specific permission by manipulating this array. The ordering of elements dictates the order on the protection form's lists.

  • '' will be ignored (i.e. unprotected)
  • 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility
  • 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility
$wgRestrictionTypes = [ 'create', 'edit', 'move', 'upload' ]

Set of available actions that can be restricted via action=protect You probably shouldn't change this. Translated through restriction-* messages. Title::getRestrictionTypes() will remove restrictions that are not applicable to a specific title (create and upload)

$wgRevisionCacheExpiry = 0

Revision text may be cached in $wgMemc to reduce load on external storage servers and object extraction overhead for frequently-loaded revisions.

Set to 0 to disable, or number of seconds before cache expiry.

$wgRevokePermissions = []

Permission keys revoked from users in each group.

This acts the same way as wgGroupPermissions above, except that if the user is in a group here, the permission will be removed from them.

Improperly setting this could mean that your users will be unable to perform certain essential tasks, so use at your own risk!

$wgRightsIcon = null

Override for copyright metadata.

$wgRightsPage = null

Override for copyright metadata.

This is the name of the page containing information about the wiki's copyright status, which will be added as a link in the footer if it is specified. It overrides $wgRightsUrl if both are specified.

$wgRightsText = null

If either $wgRightsUrl or $wgRightsPage is specified then this variable gives the text for the link. If using $wgRightsUrl then this value must be specified. If using $wgRightsPage then the name of the page will also be used as the link if this variable is not set.

$wgRightsUrl = null

Set this to specify an external URL containing details about the content license used on your wiki. If $wgRightsPage is set then this setting is ignored.

$wgRunJobsAsync = false

When $wgJobRunRate > 0, try to run jobs asynchronously, spawning a new process to handle the job execution, instead of blocking the request until the job execution finishes.

Since
1.23
$wgScript = false

The URL path to index.php.

Defaults to "{$wgScriptPath}/index.php".

$wgScriptExtension = '.php'

The extension to append to script names by default.

Some hosting providers used PHP 4 for *.php files, and PHP 5 for *.php5. This variable was provided to support those providers.

Since
1.11
Deprecated:
since 1.25; support for '.php5' has been phased out of MediaWiki proper. Backward-compatibility can be maintained by configuring your web server to rewrite URLs. See RELEASE-NOTES for details.
$wgScriptPath = '/wiki'

The path we should point to. It might be a virtual path in case with use apache mod_rewrite for example.

This needs to be set correctly.

Other paths will be set to defaults based on it unless they are directly set in LocalSettings.php

$wgSearchForwardUrl = null

Set this to a URL to forward search requests to some external location. If the URL includes '$1', this will be replaced with the URL-encoded search term.

Example:
To forward to Google you'd have something like:
'http://www.google.com/search?q=$1' .
'&domains=http://example.com' .
'&sitesearch=http://example.com' .
'&ie=utf-8&oe=utf-8';
$wgSearchHighlightBoundaries = '[\p{Z}\p{P}\p{C}]'

Regexp to match word boundaries, defaults for non-CJK languages should be empty for CJK since the words are not separate

$wgSearchSuggestCacheExpiry = 1200

Expiry time for search suggestion responses

$wgSearchType = null

Search type. Leave as null to select the default search engine for the selected database type (eg SearchMySQL), or set to a class name to override to a custom search engine.

$wgSearchTypeAlternatives = null

Alternative search types Sometimes you want to support multiple search engines for testing. This allows users to select their search engine of choice via url parameters to Special:Search and the action=search API. If using this, there's no need to add $wgSearchType to it, that is handled automatically.

$wgSecretKey = false

This should always be customised in LocalSettings.php

$wgSecureLogin = false

This is to let user authenticate using https when they come from http. Based on an idea by George Herbert on wikitech-l: https://lists.wikimedia.org/pipermail/wikitech-l/2010-October/050039.html

Since
1.17
$wgSemiprotectedRestrictionLevels = [ 'autoconfirmed' ]

Restriction levels that should be considered "semiprotected"

Certain places in the interface recognize a dichotomy between "protected" and "semiprotected", without further distinguishing the specific levels. In general, if anyone can be eligible to edit a protection level merely by reaching some condition in $wgAutopromote, it should probably be considered "semiprotected".

'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility. 'sysop' is not changed, since it really shouldn't be here.

$wgSend404Code = true

Some web hosts attempt to rewrite all responses with a 404 (not found) status code, mangling or hiding MediaWiki's output. If you are using such a host, you should start looking for a better one. While you're doing that, set this to false to convert some of MediaWiki's 404 responses to 200 so that the generated error pages can be seen.

In cases where for technical reasons it is more important for MediaWiki to send the correct status code than for the body to be transmitted intact, this configuration variable is ignored.

$wgServer = WebRequest::detectServer()

URL of the server.

Example:
$wgServer = 'http://example.com';

This is usually detected correctly by MediaWiki. If MediaWiki detects the wrong server, it will redirect incorrectly after you save a page. In that case, set this variable to fix it.

If you want to use protocol-relative URLs on your wiki, set this to a protocol-relative URL like '//example.com' and set $wgCanonicalServer to a fully qualified URL.

$wgServerName = false

Server name. This is automatically computed by parsing the bare hostname out of $wgCanonicalServer. It should not be customized.

Since
1.24
$wgServiceWiringFiles
Initial value:
= [
__DIR__ . '/ServiceWiring.php'
]

List of service wiring files to be loaded by the default instance of MediaWikiServices. Each file listed here is expected to return an associative array mapping service names to instantiator functions. Extensions may add wiring files to define their own services. However, this cannot be used to replace existing services - use the MediaWikiServices hook for that.

See Also
MediaWikiServices
ServiceContainer::loadWiringFiles() for details on loading service instantiator functions.
docs/injection.txt for an overview of dependency injection in MediaWiki.
$wgSessionCacheType = CACHE_ANYTHING

The cache type for storing session data.

For available types see $wgMainCacheType.

$wgSessionHandler = null
Deprecated:
since 1.27, MediaWiki doesn't use PHP session storage.
$wgSessionInsecureSecrets = false

If for some reason you can't install the PHP OpenSSL or mcrypt extensions, you can set this to true to make MediaWiki work again at the cost of storing sensitive session data insecurely. But it would be much more secure to just install the OpenSSL extension.

Since
1.27
$wgSessionName = false

Override to customise the session name

$wgSessionProviders
Initial value:
= [
MediaWiki\Session\CookieSessionProvider::class => [
'class' => MediaWiki\Session\CookieSessionProvider::class

MediaWiki configuration.

Value is an array of ObjectFactory specifications for the SessionProviders to be used. Keys in the array are ignored. Order is not significant.

Since
1.27
$wgSessionSecret = false

Secret for session storage. This should be set in LocalSettings.php, otherwise wgSecretKey will be used.

Since
1.27
$wgSessionsInMemcached = true

Deprecated alias for $wgSessionsInObjectCache.

Deprecated:
since 1.20; Use $wgSessionsInObjectCache
$wgSessionsInObjectCache = true
Deprecated:
since 1.27, session data is always stored in object cache.
$wgSharedDB = null

Shared database for multiple wikis. Commonly used for storing a user table for single sign-on. The server for this database must be the same as for the main database.

For backwards compatibility the shared prefix is set to the same as the local prefix, and the user table is listed in the default list of shared tables. The user_properties table is also added so that users will continue to have their preferences shared (preferences were stored in the user table prior to 1.16)

$wgSharedTables may be customized with a list of tables to share in the shared database. However it is advised to limit what tables you do share as many of MediaWiki's tables may have side effects if you try to share them.

$wgSharedPrefix is the table prefix for the shared database. It defaults to $wgDBprefix.

$wgSharedSchema is the table schema for the shared database. It defaults to $wgDBmwschema.

Deprecated:
since 1.21 In new code, use the $wiki parameter to wfGetLB() to access remote databases. Using wfGetLB() allows the shared database to reside on separate servers to the wiki's own database, with suitable configuration of $wgLBFactoryConf.
$wgSharedPrefix = false
See Also
$wgSharedDB
$wgSharedSchema = false
See Also
$wgSharedDB
Since
1.23
$wgSharedTables = [ 'user', 'user_properties' ]
See Also
$wgSharedDB
$wgSharedThumbnailScriptPath = false
$wgSharedUploadDBname = false

DB name with metadata about shared directory. Set this to false if the uploads do not come from a wiki.

$wgSharedUploadDBprefix = ''

Optional table prefix used in database.

$wgSharedUploadDirectory = "/var/www/wiki3/images"

Path on the file system where shared uploads can be found.

$wgSharedUploadPath = "http://commons.wikimedia.org/shared/images"

Full path on the web server where shared uploads can be found

$wgSharpenParameter = '0x0.4'

Sharpening parameter to ImageMagick

$wgSharpenReductionThreshold = 0.85

Reduction in linear dimensions below which sharpening will be enabled

$wgShellCgroup = false

Under Linux: a cgroup directory used to constrain memory usage of shell commands. The directory must be writable by the user which runs MediaWiki.

If specified, this is used instead of ulimit, which is inaccurate, and causes malloc() to return NULL, which exposes bugs in C applications, making them segfault or deadlock.

A wrapper script will create a cgroup for each shell command that runs, as a subgroup of the specified cgroup. If the memory limit is exceeded, the kernel will send a SIGKILL signal to a process in the subgroup.

Example:
mkdir -p /sys/fs/cgroup/memory/mediawiki
mkdir -m 0777 /sys/fs/cgroup/memory/mediawiki/job
echo '$wgShellCgroup = "/sys/fs/cgroup/memory/mediawiki/job";' >> LocalSettings.php

The reliability of cgroup cleanup can be improved by installing a notify_on_release script in the root cgroup, see e.g. https://gerrit.wikimedia.org/r/#/c/40784

$wgShellLocale = 'en_US.utf8'

Locale for LC_CTYPE, to work around http://bugs.php.net/bug.php?id=45132 For Unix-like operating systems, set this to to a locale that has a UTF-8 character set. Only the character set is relevant.

$wgShowArchiveThumbnails = true

Show thumbnails for old images on the image description page

$wgShowCreditsIfMax = true

If there are more than $wgMaxCredits authors, show $wgMaxCredits of them. Otherwise, link to a separate credits page.

$wgShowDBErrorBacktrace = false

If true, show a backtrace for database errors

Note
This setting only applies when connection errors and query errors are reported in the normal manner. $wgShowExceptionDetails applies in other cases, including those in which an uncaught exception is thrown from within the exception handler.
$wgShowDebug = false

Display debug data at the bottom of the main content area.

Useful for developers and technical users trying to working on a closed wiki.

$wgShowExceptionDetails = false

If set to true, uncaught exceptions will print a complete stack trace to output. This should only be used for debugging, as it may reveal private information in function parameters due to PHP's backtrace formatting.

$wgShowEXIF = function_exists( 'exif_read_data' )

Show Exif data, on by default if available. Requires PHP's Exif extension: http://www.php.net/manual/en/ref.exif.php

Note
FOR WINDOWS USERS: To enable Exif functions, add the following line to the "Windows extensions" section of php.ini:
extension=extensions/php_exif.dll
$wgShowHostnames = false

Expose backend server host names through the API and various HTML comments

$wgShowRollbackEditCount = 10

The $wgShowRollbackEditCount variable is used to show how many edits can be rolled back. The numeric value of the variable controls how many edits MediaWiki will look back to determine whether a rollback is allowed (by checking that they are all from the same author). If the value is false or 0, the edits are not counted. Disabling this will prevent MediaWiki from hiding some useless rollback links.

Since
1.20
$wgShowSQLErrors = false

Whether to show "we're sorry, but there has been a database error" pages. Displaying errors aids in debugging, but may display information useful to an attacker.

$wgShowUpdatedMarker = true

Show "Updated (since my last visit)" marker in RC view, watchlist and history view for watched pages with new changes

$wgSidebarCacheExpiry = 86400

Expiry time for the sidebar cache, in seconds

$wgSitemapNamespaces = false

Array of namespaces to generate a Google sitemap for when the maintenance/generateSitemap.php script is run, or false if one is to be generated for all namespaces.

$wgSitemapNamespacesPriorities = false

Custom namespace priorities for sitemaps. Setting this will allow you to set custom priorities to namespaces when sitemaps are generated using the maintenance/generateSitemap.php script.

This should be a map of namespace IDs to priority

Example:
NS_USER => '0.9',
NS_HELP => '0.0',
);
$wgSitename = 'MediaWiki'

Name of the site. It must be changed in LocalSettings.php

$wgSiteNotice = ''

Site notice shown at the top of each page

MediaWiki:Sitenotice page, which will override this. You can also provide a separate message for logged-out users using the MediaWiki:Anonnotice page.

$wgSitesCacheFile = false

Specify the file location for the Sites json cache file.

$wgSiteStatsAsyncFactor = false

Set this to an integer to only do synchronous site_stats updates one every this many updates. The other requests go into pending delta values in $wgMemc. Make sure that $wgMemc is a global cache. If set to -1, updates only go to $wgMemc (useful for daemons).

$wgSiteSupportPage = ''

If this is set, a "donate" link will appear in the sidebar. Set it to a URL.

$wgSiteTypes
Initial value:
= [
'mediawiki' => 'MediaWikiSite'

Register handlers for specific types of sites.

Since
1.20
$wgSkipSkin = ''
Deprecated:
since 1.23; use $wgSkipSkins instead
$wgSkipSkins = []

Specify the names of skins that should not be presented in the list of available skins in user preferences. If you want to remove a skin entirely, remove it from the skins/ directory and its entry from LocalSettings.php.

$wgSlaveLagCritical = 30
$wgSlaveLagWarning = 10

If lag is higher than $wgSlaveLagWarning, show a warning in some special pages (like watchlist). If the lag is higher than $wgSlaveLagCritical, show a more obvious warning.

$wgSMTP = false

SMTP Mode.

For using a direct (authenticated) SMTP server connection. Default to false or fill an array :

$wgSMTP = array(
'host' => 'SMTP domain',
'IDHost' => 'domain for MessageID',
'port' => '25',
'auth' => [true|false],
'username' => [SMTP username],
'password' => [SMTP password],
);
$wgSpamRegex = []

Edits matching these regular expressions in body text will be recognised as spam and rejected automatically.

There's no administrator override on-wiki, so be careful what you set. :) May be an array of regexes or a single string for backwards compatibility.

See Also
https://en.wikipedia.org/wiki/Regular_expression
Note
Each regex needs a beginning/end delimiter, eg: # or /
$wgSpecialPageCacheUpdates
Initial value:
= [
'Statistics' => [ 'SiteStatsUpdate', 'cacheUpdate' ]
]

Additional functions to be performed with updateSpecialPages. Expensive Querypages are already updated.

$wgSpecialPages = []

Special page list. This is an associative array mapping the (canonical) names of special pages to either a class name to be instantiated, or a callback to use for creating the special page object. In both cases, the result must be an instance of SpecialPage.

$wgSpecialVersionShowHooks = false

Show the contents of $wgHooks in Special:Version

$wgSQLiteDataDir = ''

To override default SQLite data directory ($docroot/../data)

$wgSQLMode = ''

SQL Mode - default is turning off all modes, including strict, if set. null can be used to skip the setting for performance reasons and assume DBA has done his best job. String override can be used for some additional fun :-)

$wgSquidMaxage = 18000

Cache TTL for the CDN sent as s-maxage (without ESI) or Surrogate-Control (with ESI). Without ESI, you should strip out s-maxage in the CDN config.

18000 seconds = 5 hours, more cache hits with 2678400 = 31 days.

$wgSquidPurgeUseHostHeader = true

Whether to use a Host header in purge requests sent to the proxy servers configured in $wgSquidServers. Set this to false to support Squid configured in forward-proxy mode.

If this is set to true, a Host header will be sent, and only the path component of the URL will appear on the request line, as if the request were a non-proxy HTTP 1.1 request. Varnish only supports this style of request. Squid supports this style of request only if reverse-proxy mode (http_port ... accel) is enabled.

If this is set to false, no Host header will be sent, and the absolute URL will be sent in the request line, as is the standard for an HTTP proxy request in both HTTP 1.0 and 1.1. This style of request is not supported by Varnish, but is supported by Squid in either configuration (forward or reverse).

Since
1.21
$wgSquidServers = []

List of proxy servers to purge on changes; default port is 80. Use IP addresses.

When MediaWiki is running behind a proxy, it will trust X-Forwarded-For headers sent/modified from these proxies when obtaining the remote IP address

For a list of trusted servers which aren't purged, see $wgSquidServersNoPurge.

$wgSquidServersNoPurge = []

As above, except these servers aren't purged on page changes; use to set a list of trusted proxies, etc. Supports both individual IP addresses and CIDR blocks.

Since
1.23 Supports CIDR ranges
$wgStatsdMetricPrefix = 'MediaWiki'

Prefix for metric names sent to $wgStatsdServer.

See Also
MediaWikiServices::getStatsdDataFactory
BufferingStatsdDataFactory
Since
1.25
$wgStatsdServer = false

Destination of statsd metrics.

A host or host:port of a statsd server. Port defaults to 8125.

If not set, statsd metrics will not be collected.

See Also
wfLogProfilingData
Since
1.25
$wgStrictFileExtensions = true

If this is turned off, users may override the warning for files not covered by $wgFileExtensions.

Warning
Setting this to false is insecure for public wikis.
$wgStyleDirectory = "{$IP}/skins"

Filesystem stylesheets directory. Defaults to "{$IP}/skins".

Since
1.3
$wgStylePath = false

The URL path of the skins directory. Defaults to "{$wgResourceBasePath}/skins".

Since
1.3
$wgStyleVersion = '303'

Bump this number when changing the global style sheets and JavaScript.

It should be appended in the query string of static CSS and JS includes, to ensure that client-side caches do not keep obsolete copies of global styles.

$wgSummarySpamRegex = []

Same as the above except for edit summaries

$wgSVGConverter = 'ImageMagick'

Pick a converter defined in $wgSVGConverters

$wgSVGConverterPath = ''

If not in the executable PATH, specify the SVG converter path.

$wgSVGConverters
Initial value:
= [
'ImageMagick' =>
'$path/convert -background "#ffffff00" -thumbnail $widthx$height\! $input PNG:$output'

Scalable Vector Graphics (SVG) may be uploaded as images. Since SVG support is not yet standard in browsers, it is necessary to rasterize SVGs to PNG as a fallback format.

An external program is required to perform this conversion. If set to an array, the first item is a PHP callable and any further items are passed as parameters after $srcPath, $dstPath, $width, $height

$wgSVGMaxSize = 5120

Don't scale a SVG larger than this

$wgSVGMetadataCutoff = 262144

Don't read SVG metadata beyond this point. Default is 1024*256 bytes

$wgSysopEmailBans = true

Allow sysops to ban users from accessing Emailuser

$wgTextModelsToParse
Initial value:
= [
CONTENT_MODEL_JAVASCRIPT,
CONTENT_MODEL_CSS,
]
const CONTENT_MODEL_WIKITEXT
Definition: Defines.php:278

Determines which types of text are parsed as wikitext. This does not imply that these kinds of texts are also rendered as wikitext, it only means that links, magic words, etc will have the effect on the database they would have on a wikitext page.

Todo:
On the long run, it would be nice to put categories etc into a separate structure, or at least parse only the contents of comments in the scripts.
Since
1.21
$wgThumbLimits
Initial value:
= [
120,
150,
180,
200,
250,
300
]

Adjust thumbnails on image pages according to a user setting. In order to reduce disk usage, the values can only be selected from a list. This is the list of settings the user can choose from:

$wgThumbnailBuckets = null

When defined, is an array of image widths used as buckets for thumbnail generation. The goal is to save resources by generating thumbnails based on reference buckets instead of always using the original. This will incur a speed gain but cause a quality loss.

The buckets generation is chained, with each bucket generated based on the above bucket when possible. File handlers have to opt into using that feature. For now only BitmapHandler supports it.

$wgThumbnailEpoch = '20030516000000'

If rendered thumbnail files are older than this timestamp, they will be rerendered on demand as if the file didn't already exist. Update if there is some need to force thumbs and SVG rasterizations to rerender, such as fixes to rendering bugs.

$wgThumbnailMinimumBucketDistance = 50

When using thumbnail buckets as defined above, this sets the minimum distance to the bucket above the requested size. The distance represents how many extra pixels of width the bucket needs in order to be used as the reference for a given thumbnail. For example, with the following buckets:

$wgThumbnailBuckets = array ( 128, 256, 512 );

and a distance of 50:

$wgThumbnailMinimumBucketDistance = 50;

If we want to render a thumbnail of width 220px, the 512px bucket will be used, because 220 + 50 = 270 and the closest bucket bigger than 270px is 512.

$wgThumbnailScriptPath = false

Give a path here to use thumb.php for thumbnail generation on client request, instead of generating them on render and outputting a static URL. This is necessary if some of your apache servers don't have read/write access to the thumbnail path.

Example:
$wgThumbnailScriptPath = "{$wgScriptPath}/thumb.php";
$wgThumbUpright = 0.75

Adjust width of upright images when parameter 'upright' is used This allows a nicer look for upright images without the need to fix the width by hardcoded px in wiki sourcecode.

$wgTidyBin = 'tidy'

The path to the tidy binary.

Deprecated:
Use $wgTidyConfig['tidyBin']
$wgTidyConf = $IP . '/includes/tidy/tidy.conf'

The path to the tidy config file

Deprecated:
Use $wgTidyConfig['tidyConfigFile']
$wgTidyConfig = null

Configuration for HTML postprocessing tool. Set this to a configuration array to enable an external tool. Dave Raggett's "HTML Tidy" is typically used. See http://www.w3.org/People/Raggett/tidy/

If this is null and $wgUseTidy is true, the deprecated configuration parameters will be used instead.

If this is null and $wgUseTidy is false, a pure PHP fallback will be used.

Keys are:

  • driver: May be:
    • RaggettInternalHHVM: Use the limited-functionality HHVM extension
    • RaggettInternalPHP: Use the PECL extension
    • RaggettExternal: Shell out to an external binary (tidyBin)
  • tidyConfigFile: Path to configuration file for any of the Raggett drivers
  • debugComment: True to add a comment to the output with warning messages
  • tidyBin: For RaggettExternal, the path to the tidy binary.
  • tidyCommandLine: For RaggettExternal, additional command line options.
$wgTidyInternal = extension_loaded( 'tidy' )

Set this to true to use the tidy extension

Deprecated:
Use $wgTidyConfig['driver']
$wgTidyOpts = ''

The command line options to the tidy binary

Deprecated:
Use $wgTidyConfig['tidyCommandLine']
$wgTiffThumbnailType = false

Browsers don't support TIFF inline generally... For inline display, we need to convert to PNG or JPEG. Note scaling should work with ImageMagick, but may not with GD scaling.

Example:
// PNG is lossless, but inefficient for photos
$wgTiffThumbnailType = array( 'png', 'image/png' );
// JPEG is good for photos, but has no transparency support. Bad for diagrams.
$wgTiffThumbnailType = array( 'jpg', 'image/jpeg' );
$wgTmpDirectory = false

The local filesystem path to a temporary directory. This is not required to be web accessible.

When this setting is set to false, its value will be set through a call to wfTempDir(). See that methods implementation for the actual detection logic.

Developers should use the global function wfTempDir() instead of this variable.

See Also
wfTempDir()
Note
Default changed to false in MediaWiki 1.20.
$wgTrackingCategories = []

Array holding default tracking category names.

Array contains the system messages for each tracking category. Tracking categories allow pages with certain characteristics to be tracked. It works by adding any such page to a category automatically.

A message with the suffix '-desc' should be added as a description message to have extra information on Special:TrackingCategories.

Deprecated:
since 1.25 Extensions should now register tracking categories using the new extension registration system.
Since
1.23
$wgTransactionalTimeLimit = 120

The minimum amount of time that MediaWiki needs for "slow" write request, particularly ones with multiple non-atomic writes that should be as transactional as possible; MediaWiki will call set_time_limit() if needed.

Since
1.26
$wgTranscludeCacheExpiry = 3600

Expiry time for transcluded templates cached in transcache database table. Only used $wgEnableInterwikiTranscluding is set to true.

$wgTranslateNumerals = true

For Hindi and Arabic use local numerals instead of Western style (0-9) numerals in interface.

$wgTrivialMimeDetection = false

Switch for trivial MIME detection. Used by thumb.php to disable all fancy things, because only a few types of images are needed and file extensions can be trusted.

$wgTrustedMediaFormats
Initial value:
= [
MEDIATYPE_BITMAP,
MEDIATYPE_AUDIO,
MEDIATYPE_VIDEO,
"image/svg+xml",
"application/pdf",
# "application/x-shockwave-flash",
]

list of trusted media-types and MIME types. Use the MEDIATYPE_xxx constants to represent media types. This list is used by File::isSafeFile

Types not listed here will have a warning about unsafe content displayed on the images description page. It would also be possible to use this for further restrictions, like disabling direct [[media:...]] links for non-trusted formats.

$wgTrxProfilerLimits
Initial value:
= [
'GET' => [
'masterConns' => 0

Performance expectations for DB usage

Since
1.26
$wgUniversalEditButton = true

Enable the UniversalEditButton for browsers that support it (currently only Firefox with an extension) See http://universaleditbutton.org for more background information

$wgUnwatchedPageSecret = 1

If active watchers (per above) are this number or less, do not disclose it. Left to 1, prevents unprivileged users from knowing for sure that there are 0. Set to -1 if you want to always complement watchers count with this info.

Since
1.26
$wgUnwatchedPageThreshold = false

If set to an integer, pages that are watched by this many users or more will not require the unwatchedpages permission to view the number of watchers.

Since
1.21
$wgUpdateCompatibleMetadata = false

If to automatically update the img_metadata field if the metadata field is outdated but compatible with the current version. Defaults to false.

$wgUpdateRowsPerJob = 300

Number of rows to update per job

$wgUpdateRowsPerQuery = 100

Number of rows to update per query

$wgUpgradeKey = false

When you run the web-based upgrade utility, it will tell you what to set this to in order to authorize the upgrade process. It will subsequently be used as a password, to authorize further upgrades.

For security, do not set this to a guessable string. Use the value supplied by the install/upgrade process. To cause the upgrader to generate a new key, delete the old key from LocalSettings.php.

$wgUploadBaseUrl = ''

If set, this URL is added to the start of $wgUploadPath to form a complete upload URL.

Since
1.4
$wgUploadDialog
Initial value:
= [
'fields' => [
'description' => true

Configuration for file uploads using the embeddable upload dialog (https://www.mediawiki.org/wiki/Upload_dialog).

This applies also to foreign uploads to this wiki (the configuration is loaded by remote wikis using the action=query&meta=siteinfo API).

See below for documentation of each property. None of the properties may be omitted.

$wgUploadDirectory = false

The filesystem path of the images directory. Defaults to "{$IP}/images".

$wgUploadMaintenance = false

To disable file delete/restore temporarily

$wgUploadMissingFileUrl = false

Point the upload link for missing files to an external URL, as with $wgUploadNavigationUrl. The URL will get "(?|&)wpDestFile=<filename>" appended to it as appropriate.

$wgUploadNavigationUrl = false

Point the upload navigation link to an external URL Useful if you want to use a shared repository by default without disabling local uploads (use $wgEnableUploads = false for that).

Example:
$wgUploadNavigationUrl = 'https://commons.wikimedia.org/wiki/Special:Upload';
$wgUploadPath = false

The URL path for the images directory. Defaults to "{$wgScriptPath}/images".

$wgUploadSizeWarning = false

Warn if uploaded files are larger than this (in bytes), or false to disable

$wgUploadStashMaxAge = 6 * 3600

The maximum age of temporary (incomplete) uploaded files

$wgUploadStashScalerBaseUrl = false

To enable remote on-demand scaling, set this to the thumbnail base URL. Full thumbnail URL will be like $wgUploadStashScalerBaseUrl/e/e6/Foo.jpg/123px-Foo.jpg where 'e6' are the first two characters of the MD5 hash of the file name. If $wgUploadStashScalerBaseUrl is set to false, thumbs are rendered locally as needed.

Since
1.17
$wgUploadThumbnailRenderHttpCustomDomain = false

When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom domain to send the HTTP request to.

Since
1.25
$wgUploadThumbnailRenderHttpCustomHost = false

When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom Host HTTP header.

Since
1.25
$wgUploadThumbnailRenderMap = []

When defined, is an array of thumbnail widths to be rendered at upload time. The idea is to prerender common thumbnail sizes, in order to avoid the necessity to render them on demand, which has a performance impact for the first client to view a certain size.

This obviously means that more disk space is needed per upload upfront.

Since
1.25
$wgUploadThumbnailRenderMethod = 'jobqueue'

The method through which the thumbnails will be prerendered for the entries in $wgUploadThumbnailRenderMap

The method can be either "http" or "jobqueue". The former uses an http request to hit the thumbnail's URL. This method only works if thumbnails are configured to be rendered by a 404 handler. The latter option uses the job queue to render the thumbnail.

Since
1.25
$wgUseAjax = true

Enable AJAX framework

$wgUseAutomaticEditSummaries = true

If user doesn't specify any edit summary when making a an edit, MediaWiki will try to automatically create one. This feature can be disabled by set- ting this variable false.

$wgUseCategoryBrowser = false

Use experimental, DMOZ-like category browser

$wgUseCombinedLoginLink = false

Login / create account link behavior when it's possible for anonymous users to create an account.

  • true = use a combined login / create account link
  • false = split login and create account into two separate links
$wgUseCopyrightUpload = false

Set this to true if you want detailed copyright information forms on Upload.

$wgUseDatabaseMessages = true

Translation using MediaWiki: namespace. Interface messages will be loaded from the database.

$wgUseESI = false

If you run Squid3 with ESI support, enable this (default:false):

$wgUseETag = false

Whether MediaWiki should send an ETag header. Seems to cause broken behavior with Squid 2.6, see bug 7098.

$wgUseFileCache = false

This will cache static pages for non-logged-in users to reduce database traffic on public sites. ResourceLoader requests to default language and skins are cached as well as single module requests.

$wgUseFilePatrol = true

Use file patrolling to check new files on Special:Newfiles

Since
1.27
$wgUseGzip = false

When using the file cache, we can store the cached HTML gzipped to save disk space. Pages will then also be served compressed to clients that support it.

Requires zlib support enabled in PHP.

$wgUseImageMagick = false

Resizing can be done using PHP's internal image libraries or using ImageMagick or another third-party converter, e.g. GraphicMagick. These support more file formats than PHP, which only supports PNG, GIF, JPG, XBM and WBMP.

Use Image Magick instead of PHP builtin functions.

$wgUseImageResize = true

Whether to enable server-side image thumbnailing. If false, images will always be sent to the client in full resolution, with appropriate width= and height= attributes on the tag for the client to do its own scaling.

$wgUseInstantCommons = false

Use Commons as a remote file repository. Essentially a wrapper, when this is enabled $wgForeignFileRepos will point at Commons with a set of default settings

$wgUseKeyHeader = false

Send the Key HTTP header for better caching. See https://datatracker.ietf.org/doc/draft-fielding-http-key/ for details.

Since
1.27
$wgUseLocalMessageCache = false

Set this to true to maintain a copy of the message cache on the local server.

This layer of message cache is in addition to the one configured by $wgMessageCacheType.

The local copy is put in APC. If APC is not installed, this setting does nothing.

Note that this is about the message cache, which stores interface messages maintained as wiki pages. This is separate from the localisation cache for interface messages provided by the software, which is configured by $wgLocalisationCacheConf.

$wgUseMediaWikiUIEverywhere = false

Temporary variable that applies MediaWiki UI wherever it can be supported. Temporary variable that should be removed when mediawiki ui is more stable and change has been communicated.

Since
1.24
$wgUseNPPatrol = true

Use new page patrolling to check new pages on Special:Newpages

$wgUsePathInfo
Initial value:
= ( strpos( PHP_SAPI, 'cgi' ) === false ) &&
( strpos( PHP_SAPI, 'apache2filter' ) === false ) &&
( strpos( PHP_SAPI, 'isapi' ) === false )

Whether to support URLs like index.php/Page_title These often break when PHP is set up in CGI mode. PATH_INFO may be correct if cgi.fix_pathinfo is set, but then again it may not; lighttpd converts incoming path data to lowercase on systems with case-insensitive filesystems, and there have been reports of problems on Apache as well.

To be safe we'll continue to keep it off by default.

Override this to false if $_SERVER['PATH_INFO'] contains unexpectedly incorrect garbage, or to true if it is really correct.

The default $wgArticlePath will be set based on this value at runtime, but if you have customized it, having this incorrectly set to true can cause redirect loops when "pretty URLs" are used.

Since
1.2.1
$wgUsePrivateIPs = false

Should forwarded Private IPs be accepted?

$wgUseRCPatrol = true

Use RC Patrolling to check for vandalism (from recent changes and watchlists) New pages and new files are included.

$wgUserEmailConfirmationTokenExpiry = 7 * 24 * 60 * 60

The time, in seconds, when an email confirmation email expires

$wgUserEmailUseReplyTo = true

If true put the sending user's email in a Reply-To header instead of From (false). ($wgPasswordSender will be used as From.)

Some mailers (eg SMTP) set the SMTP envelope sender to the From value, which can cause problems with SPF validation and leak recipient addresses when bounces are sent to the sender. In addition, DMARC restrictions can cause emails to fail to be received when false.

$wgUserrightsInterwikiDelimiter = '@'

Character used as a delimiter when testing for interwiki userrights (In Special:UserRights, it is possible to modify users on different databases if the delimiter is used, e.g. "Someuser@enwiki").

It is recommended that you have this delimiter in $wgInvalidUsernameCharacters above, or you will not be able to modify the user rights of those users via Special:UserRights

$wgUsersNotifiedOnAllChanges = []

Array of usernames who will be sent a notification email for every change which occurs on a wiki. Users will not be notified of their own changes.

$wgUseSharedUploads = false

If you operate multiple wikis, you can define a shared upload path here. Uploads to this wiki will NOT be put there - they will be put into $wgUploadDirectory. If $wgUseSharedUploads is set, the wiki will look in the shared repository if no file of the given name is found in the local repository (for [[File:..]], [[Media:..]] links). Thumbnails will also be looked for and generated in this directory.

Note that these configuration settings can now be defined on a per- repository basis for an arbitrary number of file repositories, using the $wgForeignFileRepos variable.

$wgUseSiteCss = true

Use the site's Cascading Style Sheets (CSS)?

$wgUseSiteJs = true

Use the site's Javascript page?

$wgUseSquid = false
$wgUseTagFilter = true

Allow filtering by change tag in recentchanges, history, etc Has no effect if no tags are defined in valid_tag.

$wgUseTeX = false

To use inline TeX, you need to compile 'texvc' (in the 'math' subdirectory of the MediaWiki package and have latex, dvips, gs (ghostscript), andconvert (ImageMagick) installed and available in the PATH. Please see math/README for more information.

$wgUseTidy = false

Set this to true to use the deprecated tidy configuration parameters.

Deprecated:
use $wgTidyConfig
$wgUseTinyRGBForJPGThumbnails = false

When this variable is true and JPGs use the sRGB ICC profile, swaps it for the more lightweight (and free) TinyRGB profile when generating thumbnails.

Since
1.26
$wgUseTwoButtonsSearchForm = true

Search form behavior.

  • true = use Go & Search buttons
  • false = use Go button & Advanced search link
$wgValidateAllHtml = false

Validate the overall output using tidy and refuse to display the page if it's not valid.

$wgValidSkinNames = []

List of valid skin names

The key should be the name in all lower case, the value should be a properly cased name for the skin. This value will be prefixed with "Skin" to create the class name of the skin to load. Use Skin::getSkinNames() as an accessor if you wish to have access to the full list.

$wgVariantArticlePath = false

Like $wgArticlePath, but on multi-variant wikis, this provides a path format that describes which parts of the URL contain the language variant.

Example:
$wgArticlePath = '/wiki/$1';

A link to /wiki/ would be redirected to /sr/Главна_страна

It is important that $wgArticlePath not overlap with possible values of $wgVariantArticlePath.

$wgVaryOnXFP = false

Add X-Forwarded-Proto to the Vary and Key headers for API requests and RSS/Atom feeds. Use this if you have an SSL termination setup and need to split the cache between HTTP and HTTPS for API requests, feed requests and HTTP redirect responses in order to prevent cache pollution. This does not affect 'normal' requests to index.php other than HTTP redirects.

$wgVerifyMimeType = true

Determines if the MIME type of uploaded files should be checked

$wgVersion = '1.27.4'

MediaWiki version number

Since
1.2
$wgVirtualRestConfig
Initial value:
= [
'modules' => []
$wgWANObjectCaches
Initial value:
= [
CACHE_NONE => [
'class' => 'WANObjectCache'

Advanced WAN object cache configuration.

Each WAN cache wraps a registered object cache (for the local cluster) and it must also be configured to point to a PubSub instance. Subscribers must be configured to relay purges to the actual cache servers.

The format is an associative array where the key is a cache identifier, and the value is an associative array of parameters. The "cacheId" parameter is a cache identifier from $wgObjectCaches. The "channels" parameter is a map of actions ('purge') to PubSub channels defined in $wgEventRelayerConfig. The "loggroup" parameter controls where log events are sent.

Since
1.26
$wgWantedPagesThreshold = 1

Number of links to a page required before it is deemed "wanted"

$wgWatchersMaxAge = 180 * 24 * 3600

Page watchers inactive for more than this many seconds are considered inactive. Used mainly by action=info. Default: 180 days = about six months.

Since
1.26
$wgWhitelistRead = false

Pages anonymous user may see, set as an array of pages titles.

Example:
$wgWhitelistRead = array ( "Main Page", "Wikipedia:Help");

Special:Userlogin and Special:ChangePassword are always whitelisted.

Note
This will only work if $wgGroupPermissions['*']['read'] is false – see below. Otherwise, ALL pages are accessible, regardless of this setting.
Also that this will only protect pages in the wiki. Uploaded files will remain readable. You can use img_auth.php to protect uploaded files, see https://www.mediawiki.org/wiki/Manual:Image_Authorization
$wgWhitelistReadRegexp = false

Pages anonymous user may see, set as an array of regular expressions.

This function will match the regexp against the title name, which is without underscore.

Example:
To whitelist [[Main Page]]:
$wgWhitelistReadRegexp = array( "/Main Page/" );
Note
Unless ^ and/or $ is specified, a regular expression might match pages not intended to be whitelisted. The above example will also whitelist a page named 'Security Main Page'.
Example:
To allow reading any page starting with 'User' regardless of the case:
$wgWhitelistReadRegexp = array( "@^UsEr.*@i" );
Will allow both [[User is banned]] and [[User:JohnDoe]]
Note
This will only work if $wgGroupPermissions['*']['read'] is false – see below. Otherwise, ALL pages are accessible, regardless of this setting.
$wgXhtmlDefaultNamespace = null

The default xmlns attribute. The option to define this has been removed. The value of this variable is no longer used by core and is set to a fixed value in Setup.php for compatibility with extensions that depend on the value of this variable being set. Such a dependency however is deprecated.

Deprecated:
since 1.22
$wgXhtmlNamespaces = []

Permit other namespaces in addition to the w3.org default.

Use the prefix for the key and the namespace for the value.

Example:
$wgXhtmlNamespaces['svg'] = 'http://www.w3.org/2000/svg';
Normally we wouldn't have to define this in the root "<html>" element, but IE needs it there in some circumstances.

This is ignored if $wgMimeType is set to a non-XML MIME type.

$wgXMLMimeTypes
Initial value:
= [
'http://www.w3.org/2000/svg:svg' => 'image/svg+xml'

Additional XML types we can allow via MIME-detection. array = ( 'rootElement' => 'associatedMimeType' )

CONTENT_MODEL_JAVASCRIPT
Initial value:
=> 'JavaScriptContentHandler',
CONTENT_MODEL_JSON => 'JsonContentHandler',
CONTENT_MODEL_CSS => 'CssContentHandler',
CONTENT_MODEL_TEXT => 'TextContentHandler',
]
NS_USER
Initial value:
=> true,
NS_USER_TALK => true,
NS_PROJECT => true,
NS_PROJECT_TALK => true,
NS_FILE_TALK => true,
NS_MEDIAWIKI => true,
NS_MEDIAWIKI_TALK => true,
NS_TEMPLATE_TALK => true,
NS_HELP => true,
NS_HELP_TALK => true,
NS_CATEGORY_TALK => true
]
poweredby
Initial value:
=> [
"mediawiki" => [
"src" => null,
"url" => "//www.mediawiki.org/",
"alt" => "Powered by MediaWiki",
]
],
]