Manual:$wgReadOnly
| Maintenance scripts setting: $wgReadOnly | |
|---|---|
| Disallows editing, displaying the string given as the reason. |
|
| Introduced in version: | Before 1.1.0 |
| Removed in version: | Still in use |
| Allowed values: | (string), null/false |
| Default value: | null (1.5.7+)false (1.1.0-1.5.6) |
| Other settings: Alphabetical | By function | |
Details
Functionally this setting is the same as $wgReadOnlyFile, but uses a string instead of a file.
If set to a string in the LocalSettings.php file, $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. Please check back in a couple of hours.';
The above example locks the wiki and provides a default statement on edit pages and also gives the included string as an explanation for why the wiki was locked. Wikitext is allowed in this string and will be rendered when the read-only warning is shown which can be used to provide links or highlight upgrade notifications.
 Warning: | In contrast to its name, this settings does not make the database read only! Even if $wgReadOnly is set, extensions, API scripts and other cacheable events can write data nonetheless. |
Upgrading
Since MediaWiki 1.27, running the upgrade script will not work if $wgReadOnly is set.
A simple solution is to set it to read only when not running from the command line, which will not affect the command line update script:
$wgReadOnly = ( PHP_SAPI === 'cli' ) ? false : 'This wiki is currently being upgraded to a newer software version. Please check back in a couple of hours.';
Sessions
If sessions are not stored on an external caching system such as Redis or Memcached, users may get logged-out, and no further login attempts would succeed during the time the wiki is set read only, receiving a message similar to:
There seems to be a problem with your login session;
this action has been canceled as a precaution against session hijacking.
Please resubmit the form.
DB caching
Caches that use the database cannot be written to during read only mode, which could prevent more than just editing (depending on the configuration, logging in or even viewing pages). 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 = $wgSessionCacheType = 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 $wgMainCacheType and $wgLocalisationCacheConf for details.
If you want to enable logins while the database is readonly, at least $wgSessionCacheType needs to be set to some real non-DB caching mechanism.
Thumbnails
When in read-only mode, images which need to be transformed or scaled will be shown as an error message instead of as an image. To avoid this problem, put the following in the "LocalSettings.php" file:
$wgIgnoreImageErrors = true;