Manual:$wgReadOnly

From MediaWiki.org
Jump to: navigation, search

Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎italiano • ‎日本語 • ‎polski • ‎português
Wiki locking: $wgReadOnly
Disallows editing, displaying the string given as the reason.
Introduced in version: pre 1.1.0
Removed in version: still in use
Allowed values: (string), null/false
Default value: null
false, prior to 1.5.7

Other settings: Alphabetical | By Function

Details[edit | edit source]

Functionally this setting is the same as $wgReadOnlyFile, but uses a variable instead of a file.

If set to a string in "LocalSettings.php", $wgReadOnly disallows editing, displaying the string given as the reason. The reason provided is preceded by the contents of MediaWiki:Readonlywarning.

$wgReadOnly = 'This wiki is currently being upgraded to a newer software version.';

The above example locks the database and provides a default statement on edit pages and also gives the included string 'This wiki is currently being upgraded to a newer software version.' as an explanation for why the database was locked.

Some of your installed extensions may write data nonetheless.

DB caching[edit | edit source]

Some caches that use the database may still be written to during read only mode. This can be avoided by disabling cache, albeit at the cost of making your wiki slow. This can be accomplished with the following settings in LocalSettings.php:

$wgMessageCacheType = $wgMainCacheType = $wgParserCacheType = CACHE_NONE;
$wgLocalisationCacheConf['storeClass'] = 'LCStoreNull';

If you want your wiki to be fast, while still not using the DB, you should consider using something like Memcached. See Manual:$wgMainCacheType and <tvar|localisationCacheConf>Manual:$wgLocalisationCacheConf for details.