Manual:$wgUseInstantCommons

From MediaWiki.org
Jump to navigation Jump to search
Other languages:
Deutsch • ‎English • ‎Nederlands • ‎español • ‎français • ‎magyar • ‎polski • ‎русский • ‎中文 • ‎日本語
Shared uploads: $wgUseInstantCommons
Enable InstantCommons, i.e. the use of Wikimedia Commons as a shared repository
Introduced in version:1.16.0 (r58652)
Removed in version:still in use
Allowed values:(boolean)
Default value:false

Usage[edit]

Add the following to your LocalSettings.php to enable InstantCommons:

$wgUseInstantCommons = true;

Details[edit]

Setting this configuration parameter to true enables InstantCommons, which allows to automatically use in the local wiki images hosted in Wikimedia Commons.

This configuration parameter's setting is a shorthand for the following setting to $wgForeignFileRepos :

$wgForeignFileRepos[] = [
	'class' => 'ForeignAPIRepo',
	'name' => 'wikimediacommons',
	'apibase' => 'https://commons.wikimedia.org/w/api.php',
	'url' => 'https://upload.wikimedia.org/wikipedia/commons',
	'thumbUrl' => 'https://upload.wikimedia.org/wikipedia/commons/thumb',
	'hashLevels' => 2,
	'transformVia404' => true,
	'fetchDescription' => true,
	'descriptionCacheExpiry' => 43200,
	'apiThumbCacheExpiry' => 0,
];

Note[edit]

Enabling this configuration parameter does not avoid any usage of disk space on the server running the local wiki. Until MediaWiki 1.26, this setting did indeed generate thumbs on the local disk for caching purposes. In case the dimensions of the original file on Wikimedia Commons are exceeded when embedding the file on a page in the local wiki, the file will in its original size be put onto the local disk.

Since MediaWiki 1.27 (gerrit:251556), $wgUseInstantCommons hotlinks images from Commons by default instead of downloading originals and thumbnailing them locally.

This allows wikis to save on CPU and bandwidth while reducing time to first byte for pages, even without a thumbnail handler. However, the downside can be that pages can load slowly if they haven't loaded in the past 12 hours. For example, if you have 100 InstantCommons images on a page, your wiki will make 400 API requests to the Commons API at page load time and the first byte of the page won't be returned for about 30 seconds. This behavior is logged as bug T190576, but in the meantime, you may prefer to override the default descriptionCacheExpiry and apiThumbCacheExpiry by creating your own $wgForeignFileRepos entry, or maybe not use foreign file repositories at all and instead copy images from Commons to your own wiki using importImages.php .

See the documentation of configuration parameter $wgForeignFileRepos for tweaks.

See also[edit]