Manual:Performance tuning/en

This page provides an overview of different ways to improve the performance of MediaWiki.

Context

MediaWiki is capable of scaling to meet the needs of large wiki farms such as those of Wikimedia Foundation, WikiHow and Fandom and can take advantage of a wide number of methods including multiple load-balanced database servers, memcached object caching, Varnish caches (see Manual:Varnish caching) and multiple application servers. For most smaller installations, this is overkill though, and simply enabling object caching and optimizing PHP performance should suffice.

Quick start

Short version: We recommend bytecode cache for PHP, APCu as local object cache, Memcached for main cache; this is what the Wikimedia Foundation uses for Wikipedia et al.

In some cases, over-caching at too many levels may degrade performance.

Quick start with Puppet

Most of the tweaks on this page have been collected in a puppet manifest (puppet/modules/role/manifests/simple_performant.pp and puppet/modules/role/manifests/simple_miser.pp). If you install Puppet, you can apply them to your server with a single command.

PHP

Bytecode caching

See PHP configuration#Opcode caching.

PHP works by compiling a PHP file into bytecode and then executing that bytecode. The process of compiling a large application such as MediaWiki takes considerable time. PHP accelerators work by storing the compiled bytecode and executing it directly reducing the time spent compiling code.

OPcache is included in PHP 5.5.0 and later and is the recommended accelerator for MediaWiki. Other supported op code caches are: WinCache.

Opcode caches store the compiled output of PHP scripts, greatly reducing the amount of time needed to run a script multiple times. MediaWiki does not need to be configured to do PHP bytecode caching and will "just work" once installed and enabled.

Since MediaWiki 1.36, it may be slower on systems without op code caching. See <translate> task <tvar name=1>T274041</tvar></translate>.

Object caching

For more information about local server, main cache and other cache interfaces, see Manual:Caching.

Local server

This interface is used for lightweight caching directly on the web server. This interface is expected to persist stored values across web requests.

Presence of a supported backend is automatically detected by MediaWiki. No MediaWiki configuration necessary.

For PHP 7+, you should install APCu or WinCache. (On PHP 5, APCu was known to be unstable in some cases.)

To install APCu, use:

sudo apt-get install php-apcu php-igbinary

A script, apc.php is bundled with the APCu package which can be used to inspect the status of the cache, and also examine the contents of the user cache to verify that MediaWiki is correctly using it.

Main cache

This interface is used as the main object cache for larger objects.

The main cache is disabled by default and needs to be configured manually. To enable it, set $wgMainCacheType to a key in $wgObjectCaches . There are preconfigured interfaces for Memcached, APC, and MySQL. You can configure additional backends via $ObjectCaches (e.g. for Redis).

// Default:
// $wgMainCacheType = CACHE_NONE;

Single web server

If you have APC installed is strongly recommended to use that by setting the following in LocalSettings.php :

$wgMainCacheType = CACHE_ACCEL;

Once set, the user session store and parser output cache will also inherit this MainCacheType setting.

When using APC with limited RAM (and no Memcached or other object cache configured), then important objects might be evicted too often due to the size of parser output cache building up. Consider setting $wgParserCacheType to CACHE_DB, which will move those keys out to the database instead.

If using $wgMainCacheType = CACHE_ACCEL; and users are unable to login due to "session hijacking" errors, consider overriding $wgSessionCacheType to CACHE_DB. See task T147161 for more info.

If you can't use APC, consider installing Memcached (requires at least 80MB of RAM). While installing Memcached is considerably more complicated, it is very effective.

If neither APC or Memcached is an option, you can fallback to storing the object cache in your database. The following preset will do that:

$wgMainCacheType = CACHE_DB;

Multiple web servers

If your MediaWiki site is served by multiple web servers, you should use a central Memcached server. Detailed instructions are on the memcached page.

It is important that you do not use APC as your main cache if you have multiple web servers. This cache must be coordinated centrally for a single MediaWiki installation. Having each web server use APC as its own MainCache will cause stale values, corruption or other unexpected side-effects. Note that for values that are safe to store in uncoordinated fashion (the "local-server cache"), MediaWiki automatically makes use of APC regardless of this configuration setting.

Interwiki cache

MediaWiki interwiki prefixes are stored in the interwiki database table. See Interwiki cache for how to enable caching.

Localisation cache

By default, interface message translations are cached in the l10n_cache database table. Ensure $wgCacheDirectory in LocalSettings.php is set to a valid path to use a local caching instead. See Help:System message#Caching for more details.

Sidebar cache

A small save in DB queries can be obtained by caching the sidebar (disabled by default). See $wgEnableSidebarCache and $wgSidebarCacheExpiry .

Page view caching

Page view caching increases performance tremendously for anonymous (not logged-in) users. It does not affect performance for logged-in users.

Caching proxy

A caching proxy (or "HTTP accelerator") stores a copy of web pages generated by your web server. When such page is requested a second time, then the proxy serves up its local copy, instead of passing the request onto the real web server.

This massively improves the response times for page loads by end users, and also tremendously reduces the computational load on the MediaWiki web server. When a page is edited, MediaWiki can automatically purge the local copy from the cache proxy.

Examples of cache proxies:

• Varnish Cache, this is currently (as of November 2018) used by Wikipedia. See also Manual:Varnish caching.
• Squid, this was used by Wikipedia prior to 2012.
• Apache's mod_cache_disk, see this article for instructions with MediaWiki.

File cache

See Manual:File cache for main article about this.

In absence of a caching proxy or HTTP accelerator, MediaWiki can optionally use the file system to store the output of rendered pages. For larger sites, using an external cache like Varnish is preferable to using the file cache.

Web server

• if you use Apache as web server, use PHP-FPM, not mod_php. PHP-FPM optimizes re-use of PHP processes.
  • switch Apache to use the event MPM instead of the prefork MPM.
• adjust robots.txt to disallow bots from crawling history pages. This decreases general server load. See Manual:Robots.txt .
• HTTP/2 protocol can help, even with ResourceLoader.

Configuration settings

Large sites running MediaWiki 1.6 or later should set $wgJobRunRate to a low number, say 0.01. See Manual:Job queue for more information.

Composer

This will provide no benefit if you enable opcache in PHP.

MediaWiki uses composer for organizing library dependencies. By default these are included from the /vendor directory using a dynamic autoloader. This autoloader needs to search directories which can be slow. It is recommended to generate a static autoloader with Composer, which will make your wiki respond faster.

Using a static autoloader is the default for all MediaWiki installations from the tarball download or from Git. If for some reason this is not the case, use the following to generate the static autoloader:

composer update -o --no-dev

Remember that this will need to be re-run after each MediaWiki update as it includes a static copy of which libraries and classes exist in the software.

Database configuration

MySQL

For a heavy concurrent write load, InnoDB is essential. Use memcached, not the default MySQL-based object cache.

See below for some DB configuration tricks. You can also try and run the mysql-tuning-primer script to get some quick statistics and suggestions.

Multiple servers

The database software and web server software will start to fight over RAM on busy MediaWiki installations that are hosted on a single server. If your wiki has a consistent traffic, a logical step, once other performance optimizations have been made (and cache serves most of the content), is to put the database and web server on separate servers (or, in some cases, multiple separate servers, starting with a replica.) Also:

• check that MySQL has query cache enabled and enough memory;
• give most memory to innodb_buffer_pool;
• add cores for MySQL if maxed out at peak times;
• give memcached even more RAM for in-memory cache.

Benchmarking

Some tools can help quickly evaluate the effects of performance tuning.

• http://webpagetest.org is "real life" testing, commanded in your browser.
• ab is a command line tool which quickly produces some nice stats.
• PageSpeed

See also

• http://dammit.lt/2007/01/26/mediawiki-performance-tuning/ : APC and a few simple settings that boost performance
• More extensive changes, sacrificing some functionality
  • How to make MediaWiki fast
  • Comprehensive MediaWiki performance optimisation (mostly redundant with this page and what above)
• User:Ilmari Karonen/Performance tuning, focusing on small wikis
• Use cases:
  • Wikipedia: Site internals, configuration, code examples and management issues [PDF, 2007]
  • Caching, minification, domain-sharing and compression techniques used by WikiFur
• For developers:
  • Logging and Manual:Profiling
  • North's Performance chapter
• Wikimedia specific documentation:
  • Backend performance guide of the Wikimedia Performance Team
  • Frontend performance guide of the Wikimedia Performance Team