Manual:Upgrading



File transfer
Choose a method for transferring files:


 * wget


 * Secure copy with [http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html SCP] or WinSCP


 * SSH File Transfer Protocol (SFTP)


 * Using a FTP client.


 * The hosting company might provide a file manager interface via the web browser; check with your provider.

There is a list of these at List of file transfer protocols
 * Some other method.

Preliminary
Read.


 * 1) Check the requirements


 * 1) Read the release notes


 * 1) Back up existing files and the database


 * 1) Unpack the new files


 * 1) Upgrade extensions


 * 1) Run the update script to check the database


 * 1) Test the update


 * 1) Remove leftovers from old installations

Check requirements
MediaWiki  requires:


 * PHP +


 * One of the following:
 * MySQL + (or equivalent MariaDB)
 * PostgreSQL +
 * SQLite +

If you are using PostgreSQL, please also read .

For more information, please read the  and .

Read the release notes
Within the distribution tarball, or within the files checked out/exported from gerrit>Special:MyLanguage/Gerrit|Git, there are a number of files with capitalized filenames, one of which contains the  (1>Special:MyLanguage/Release notes|wiki).

Now's the time to open it up and find out what's been changed in this release.

Clear pending jobs
For performance reasons, some actions in the database are delayed, and are managed by the man>Special:MyLanguage/Manual:Job queue|job queue.

Those jobs are stored in database and contain parameters with information about actions it should perform.

It's strongly recommended to run those pending jobs before upgrading the wiki, to avoid them failing in case the parameter specification of those jobs change on the new version.

Use <tvar|runJobs></> to run all pending jobs and clear the queue before performing the upgrade.

Back up existing files and the database

 * Full instructions: <tvar|backingup></>

While the upgrade scripts are well-maintained and robust, things could still go awry. Before proceeding to update the database schema, make a full backup>Special:MyLanguage/Manual:Backing up a wiki</>|backup of the wiki, including both the database and the files:


 * the wiki's content, from the database, (make sure you get the character set specified correctly, first check LocalSettings.php). It may be a good idea to create an XML dump in addition to the SQL database dump.
 * * MySQL, both SQL dump and XML dump are for use with the  command:

mysqldump --user=wikidb_user --password=wikidb_userpassword wikidb > file.sql mysqldump --user=wikidb_user --password=wikidb_userpassword wikidb --xml > file.xml
 * * PostgreSQL, database dump for use with  command:

pg_dump --create -Fc wikidb > file.db.dump
 * * SQLite, you use a MediaWiki script for making a backup:

php wikifolder/maintenance/sqlite.php --backup-to file


 * images and other media files (the contents of the  directory, custom logo /skins/common/images/wiki.png)


 * configuration files, e.g.  and   (if present)


 * MediaWiki's program files, including all skins and extensions, especially if you modified them.

Using a tarball package
You can put the new files into place using FTP or the command line. Use the command line, if you have access to it! Using the command line will be much faster than having to upload each single one of the thousands of files via FTP.

FTP or graphical
If you cannot access the command line on your server, download the MediaWiki tarball to your local computer and use <tvar|7zip>7zip</> to extract the tarball on your local PC.

After you extracted the files locally, use your favorite FTP client software to upload directories and files to the server.

Command line
You may need to run the command as  if you don't have full write permissions to the wiki install directories under your current user. When untarring a tarball package normally a new directory for the new wiki version will be created and you will have to copy the old configuration files and images directory from your old installation directory:

$ cd /path/to/your/new/installation/ $ wget https://releases.wikimedia.org/mediawiki//mediawiki-.tar.gz $ tar -xvzf mediawiki-.tar.gz $ rm mediawiki-.tar.gz

(Open)Solaris users should use gtar, or:

$ gzip -dc mediawiki-.tar.gz | tar xf -

Other files
After extracting the tarball, you should copy or move some files and folders from the old installation directory to the new one:


 * <tvar|code-lc> </>, which contains your old configuration settings.


 * The <tvar|code-img> </> (or <tvar|code-upl> </> in older versions) directory, which contains all the uploaded files to the wiki, unless you have chosen a different upload directory, and change the ownership and permissions. <tvar|chmod> </> and <tvar|chgrp> </> (e.g. if your web user is apache).


 * Some extensions in the <tvar|dir> </> directory. You should always get updated extensions, old extensions aren't guaranteed to work with a newer version of MediaWiki.


 * In case you use a logo>Special:MyLanguage/Manual:$wgLogo</>|custom logo this file also needs to be restored from backup. Before 1.24 usually in <tvar|dir1> </>. After 1.24 in <tvar|dir2> </> or <tvar|dir3> </> if that's what you chose to use. Then add to LocalSettings.php e.g. <tvar|logo2> </>


 * Custom skins from within the <tvar|skins-dir> </> directory.


 * Any modifications made to the old installation files or extensions.


 * Any .htaccess file (if you're using Apache and you've defined any rules in them).

Once done, make this new folder the published folder on the web server, or rename the old installation directory and then rename the new one to match the old name.

Using Git
If using <tvar|git></>, export the files into a clean location, and then copy the old customized files into the new location as described in the previous section.

You will also need to install some external PHP libraries using Composer or a provided collection maintained for the Wikimedia wiki farm. More details on installing and updating external libraries can be found in the download>Download_from_Git#Fetch_external_libraries</>|Git download documentation.

Using patch
A small patch file is usually made available for a minor version upgrade. Manually download and extract the patch file from [<tvar|dumps>https://releases.wikimedia.org/mediawiki/</> the dumps site] or follow the directions with wget below. Patches are incremental, you can not  skip a version.


 * 1) cd to your main MediaWiki directory (the one with LocalSettings.php).


 * 1) Download the patch file and gunzip it.


 * 1) Use <tvar|patch> </> to check what will be changed (e.g., <tvar|patch2> </>)


 * 1) If all is well, run patch again without <tvar|dry> </>.


 * 1) Check your Special:Version and you should see the new version number in place.

Files remaining that may cause errors
If you unpacked over the old installation directory, some old files can cause problems with the new version.

If you are not using profiling>Special:MyLanguage/Manual:Configuration settings#Profiling</>|profiling, but have a <tvar|stprof> </> file in the MediaWiki root folder, you may receive errors referring to <tvar|dir> </>. Deleting, or renaming, the <tvar|stprof> </> file will resolve this error. The <tvar|sample> </> file, also in the MediaWiki root folder, can serve as a template should you enable profiling in the future.

MediaWiki 1.23 deprecates the skin autodiscovery mechanism of core skin files. After upgrading to this version, you should ensure that the old files <tvar|chick> </>, <tvar|nostalgia> </>, <tvar|simple> </> and <tvar|standard> </> directly in the <tvar|dir> </> directory as well as the according subfolders inside the <tvar|dir2> </> directory got removed. MediaWiki will log warnings if any of them are still found to help you remember. (You will also need to adjust any custom skins to follow a similar convention.) See <tvar|discovery></> for details.

MediaWiki 1.24 changes the paths of core skin files. After upgrading to this version, you should ensure that the old files <tvar|cologne> </>, <tvar|modern> </>, <tvar|monobook> </> and <tvar|vector> </> directly in the <tvar|dir> </> directory are no longer present. See <tvar|discovery></> for details.

Upgrade extensions
Certain extensions have been updated in order to work with the new version of MediaWiki. Be sure to upgrade to the latest versions of such extensions. You might need to perform manual updates to custom extensions.

Different tar>Special:MyLanguage/tarballs</>|tarballs include some subsets of extensions and have versioning which helps you upgrade choosing the right one for your MediaWiki core release.

special>Special:ExtensionDistributor</>|Extension Distributor works well for most people who want a snapshot of extensions that will work with their supported versions of MediaWiki.

If you want a lot of extensions then download>Special:MyLanguage/Download from Git</>|downloading from Git is probably best.

If you don't have Git but you want to upgrade a lot of extensions, you might consider using mwExtUpgrader.

Adapt your LocalSettings.php
If you use the same <tvar|localsettings> </> from the old version, you may need to adapt it to how new versions handle it:

Skin registration
Since MediaWiki 1.24, bundled skins like Vector, Monobook, Modern and CologneBlue are no longer part of MediaWiki core, and they need to be registered explicitly in <tvar|localsettings> </> to use them, otherwise MediaWiki will warn that you don't have installed skins.

This is what you need to add to <tvar|localsettings> </> when upgrading from versions older than 1.24 and want to have available one of those skins:

Other skins may still not be adapted to the new skinreg>Manual:Extension registration</>|skin registration system, so refer to the documentation page about each skin to see how to register it properly in case of problems.

Extension registration
Since MediaWiki 1.25, extensions use a new extreg>Manual:Extension registration</>|extension registration system.

Previously your <tvar|1> </> would include something like:

This can be converted to:

Extensions are being adapted to use the new extension registration system.

Extensions that are not adapted should use the old way of installing them.

Refer to the installation instructions on the extension's page for more information.

Other variables
Some variables may be obsolete or even removed.

Having them in <tvar|localsettings> </> usually won't have any effect.

New variables may be added in newer versions, or some existing variables changed their type.

We usually try to use sane defaults for them, and in case of type change, be backwards compatible.

In any case, take a look to the release notes to see those changes.

Run the update script
You can upgrade the MediaWiki database in two ways: Either from the command line or from the web browser. If you have shell access to your server, upgrading from the command line is recommended, since this reduces the risk of the upgrade process being interrupted by a timeout or connection reset.

The script will also attempt to download any missing dependencies which MediaWiki needs.

Command line
Access the command line of your server or an SSH shell or similar. You can access the command line by connecting to your server via SSH. If the local PC you are working on runs Microsoft Windows, you will need a tool like <tvar|putty>PuTTY</> to use SSH. From the command line or the Shell, change to the <tvar|maint-dir> </> directory and execute the script>Special:MyLanguage/Manual:update.php</>|update script:

$ php update.php

On a Linux server if you get an error try performing the same command as root ( sudo php update.php ). Note for simple installations on Windows (e.g. with <tvar|xampp></>): First make sure that your web server (such as Apache) and your database (such as MySQL) are running. Then run : right-click it, select Open With, and browse to PHP.exe. The resulting command prompt window will likely autoclose when the schema upgrade completes.

You might see a message that your PHP version is too old and that MediaWiki needs a newer version. After that message the update aborts. Reason for this error is that the command line can use another PHP version than that one which you have when you execute MediaWiki from the web server. When you get this message you should check, if you can execute a newer PHP version on the shell by using a different command: That might e.g. be php5 or php56. If another version is available and - if so - under which name, depends on the setup of your server. If it does not work, ask your hoster; he will surely know.

MediaWiki will inspect the existing schema and update it to work with the new code, adding tables and columns as needed.

What to do in case of "ALTER command denied to user" error (or similar)
In case the scripts abort with a message similar to:

Error: 1142 ALTER command denied to user 'wiki'@'localhost' for table 'mytable' (localhost) ERROR: must be the owner of the mytable relation

This means that you should check that you have defined <tvar|1></> and <tvar|2></> in your <tvar|3></> file (in the main directory). These are the user and password needed by this script in order to access to the database.

In some cases, an old $wgDBmwschema variable (for Postgres) seems to be read for the table name to update instead of $wgDBname, even when mysql is used. If this is the case, just get rid of the $wgDBmwschema definition in LocalSettings.php.

What to do in case of "unexpected T_STRING" error
Individuals running update.php from the command line may encounter the following error:

<pre style="overflow:auto;"> syntax error, unexpected T_STRING, expecting T_OLD_FUNCTION or T_FUNCTION or T_VAR or '}' \ in ~/maintenance/commandLine.inc on line 13

This error occurs when update.php is run from php4.

Individuals who have their site hosted by providers who provide both php4 and php5 should take the following steps:


 * 1) from the command line, enter the command 'whereis php5'


 * 1) once you have discerned the location of the php5 path, list the contents of php5/bin directory


 * 1) once you've determined the name of the php executable (either php or php5), type in the entire path to execute update.php

Below is an example:

<pre style="overflow:auto;"> $ whereis php5 $ ls -la /usr/local/php5/bin $ /usr/local/php5/bin/php update.php

What to do in case of 'register_argc_argv is set to false' error
You may encounter the error: <pre style="overflow:auto;"> Cannot get command line arguments, register_argc_argv is set to false


 * 1) Go to ~/maintenance. Either edit an existing 'php.ini' file, or create one.


 * 1) Add a line as follows:

<pre style="overflow:auto;"> register_argc_argv=true


 * 1) Re-run php update.php

Web browser

 * See also <tvar|update></>

If your database is already big and in high production usage, then you should not be using the Web updater, e.g. because the update process will time out when the maximum_execution_time is reached. In that case you should use update.php from the command-line interface (not from the web). What exactly is "too big" depends on your server (e.g. on its performance, the load and on how long the maximum execution time of PHP allows the script to run). If your wiki is too big for the web updater and your hosting provider does not allow command-line access, then you need to migrate your wiki to another hosting account, preferably to one that does have shell access.


 * 1) Always back up before performing database maintenance.


 * 1) Navigate your webbrowser to  . For example, if your wiki is at , then navigate to.


 * 1) Select your language and click continue.


 * 1) The existing installation should be detected. Follow the instructions on the screen to upgrade it. If asked for the "upgrade key", open your <tvar|localsettings></> file and look for the key assigned to <tvar|upgkey></>.

It might happen that the web-updater does not seem to work: Instead of seeing the initial language selection screen, you might see an empty wiki page, possibly with some error message. In this case it is most likely that your webserver uses Rewrite Rules (most likely for shorturl>Special:MyLanguage/Manual:Short URL</>|short URLs), which do not show you the updater at mw-config/, but a wiki page at Mw-config/, with capital "M". In this case, rename the .htaccess file for the time of the update. Then you should be able to access the web-updater.

Test the update
Once the upgrade has been completed, browse to the wiki and check that the following operations work as expected:


 * Viewing pages
 * Editing pages
 * Uploading a file
 * Visit <tvar|version>Special:Version</> and check that the version shown is correct and that the extensions are present.

Remove leftovers from old installations
If you have copied your previous installation to another folder on the server, be sure to remove it or make it completely inaccessible from the web. Is very important to not leave old installations accessible from the web, since it completely defeats the purpose of upgrading, and leaves your server open to attacks.

Frequently asked questions
<section begin=FAQ />

How hard is it to upgrade?
If the only file you have modified is <tvar|localsettings></>, and you are upgrading from 1.5 or later, the process is very simple. The amount of human work involved is only a few minutes. The database schema changes will take an amount of time proportional to the size of your database — potentially hours for wikis with millions of pages, but for a more typical size of a few thousand pages, it is usually done in seconds.

Minor upgrades, within the same major version, say from .0 to, do not require any schema changes at all. You can just update the files. The database needs no update, hence it is not necessary to run the updater script.

Upgrading from 1.4 or earlier is potentially complicated because support for character sets other than UTF-8 was dropped, and the schema for storing bulk text changed. Please read the relevant section in the  file.

Upgrading becomes difficult if you have modified our source code, and you don't want your changes to be overwritten. Tools such as <tvar|diff>diff</>, <tvar|patch>patch</>, <tvar|meld>Meld</> or <tvar|winmerge>WinMerge</> may be useful. There is also potential for trouble if you are using unmaintained extensions. Upgrade your extensions at the same time as you upgrade MediaWiki.

If you have modified the skin or use a custom skin you very likely will have to adjust it to work again with the new version of MediaWiki.

How do I upgrade from a really old version? In one step, or in several steps?
It depends: If you are upgrading from MediaWiki 1.4 or older, you should upgrade to MediaWiki 1.5 first. If you are upgrading from a Latin-1 wiki, use upgrade1_5.php (found in MediaWiki 1.5) to convert the relevant parts of the database to UTF-8 (<tvar|latin></> needs to be set to true in your <tvar|localsettings></> for this to work). Next, run update.php, and then set the <tvar|legacy></> option in LocalSettings.php to the encoding previously used by the wiki (e.g. windows-1252). This is basically how Wikipedia and other Wikimedia Foundation sites were upgraded from MediaWiki 1.4 to 1.5 – see the [<tvar|noc>http://noc.wikimedia.org/conf/highlight.php?file=InitialiseSettings.php</> relevant settings file (warning: huge page!)] and some wikitech>wikitech:1.5 upgrade</>|related notes at Wikitech. You may need to upgrade to MediaWiki 1.4 before running the upgrade1.5 script.

If you want to make a database dump (e.g. MySQL) of your Latin-1 wiki, make sure the type of the  field in the <tvar|text></> table is , not  , to avoid character encoding issues.

If you are upgrading from MediaWiki 1.5 or newer, you can upgrade in one step, from your old version to the latest stable version. The vast majority of reports, as well as automated testing, indicate that doing it in one step works just fine. If you have trouble believing this, read mail>mailarchive:mediawiki-l/2008-October/028975.html</>|this mailing list post. However, please note that when you update from old versions, chances that you will encounter PHP errors are bigger than when you upgrade from the version directly previous to the new version. You would have received these errors anyway, also if you had not skipped versions, but if you had each time done each single update. Only will you - when you skipped versions - get them all at the same time. This will make the upgrade more difficult, but do not forget that you did not have the trouble updating to the intermediate versions, which you skipped!

Should I back up first?
Short answer: Yes.

Long answer: It depends on a) how much you value your data, b) how hard it is to create a backup and c) how confident you are with MySQL maintenance and administration.

An upgrade failure may leave your database in an inconsistent state, in between two versions. A PHP or MySQL error might happen during upgrade leaving your database partly upgraded. In such situations it may be possible to somehow fix this problem with much manual work. However, it will be way easier to just put a database backup from before running update.php in place and to continue with that. Otherwise you might have hours of - needless - work.

Recovery is often complex. Volunteers on the support forums are unlikely to be impressed if you neglect to make a backup and then need help to recover from upgrade-related corruption. A better outcome is if you can revert to your backup, and then [<tvar|phab>https://phabricator.wikimedia.org/maniphest/task/create/</> report the bug against the corresponding MediaWiki project] in the upgrade process which caused the corruption.

Can I keep my LocalSettings.php?
Yes, but you may have to make some minor changes. The format of <tvar|localsettings></> is largely backwards compatible. Changes which break LocalSettings.php compatibility will be documented in the "configuration changes" section of the release notes.

Can my wiki stay online while it is upgrading?
Generally yes, however Git may temporarily (for a few seconds) break it.

If you are upgrading between minor releases of MediaWiki, all you need to do is update the source files.

Note: the following assumes you have command line access. If you are upgrading between major releases of MediaWiki, the preferred procedure is as follows:


 * 1) Unpack the new version of MediaWiki into a new directory


 * 1) Prepare that new directory: copy your current LocalSettings.php from the old directory, copy any installed extensions and custom skins (if any). Check <tvar|Logo></> setting in LocalSettings.php and if necessary copy logo file from the old directory to the new directory.


 * 1) In the release notes for the new version, see if any changes need to be made to LocalSettings.php.


 * 1) Place the database in read-only mode by inserting the following variable into LocalSettings.php in the old directory - users will see this message if they attempt an edit during the upgrade process:


 * 1) * This no longer works since MediaWiki 1.27, which also prevents running the update script. A workaround for versions since MediaWiki 1.27 can be found in <tvar|ReadOnly></>. See also.


 * 1) Run the upg>Special:MyLanguage/Manual:Upgrading#Command_line</>|update script or the web updater in the new directory.


 * 1) Copy the images from the images sub-directory from the old directory to the new directory.


 * 1) Swap the old directory and the new directory.

Why upgrade?

 *  Subscribe to <tvar|announce>mediawiki-announce</> to be notified of new releases. 

Because it's upgrade>#How hard is it to upgrade?</>|usually easy enough, steps>#How do I upgrade from a really old version? In one step, or in several steps?</>|a single step from your version to latest and also updater>Special:MyLanguage/Manual:Upgrading#Web updater</>|via web.

Recent releases receive security fixes to keep your wiki and your host safe from vandals, while old releases don't (see <tvar|lifecycle></>). That makes dozens good reasons to upgrade!

New major releases come with new features, which you might want to use: see the release notes for details. In case you need additional arguments to convince your bosses to let you upgrade from a pretty old version, here is a summary:


 * Since 1.5, 1>Special:MyLanguage/Release notes/1.5#Smaller changes since 1.4</>|edits can be previewed before saving also as diff.


 * Since 1.9, an 1>Special:MyLanguage/Release notes/1.9#Undo revision</>|undo button is available.


 * Since 1.12, patrol>Special:MyLanguage/Help:Patrolling</>|patrolling on Special:NewPages is much easier.


 * Since 1.13, you can moving>Special:MyLanguage/Help:Moving a page</>|rename (move) files.


 * Since 1.14, you can FixDoubleRedirects>Special:MyLanguage/Manual:$wgFixDoubleRedirects</>|fix double redirects automatically.


 * Since 1.16, <tvar|commons></> is available.


 * If you have appropriate caching, since 1.17 <tvar|loader></> optimizes pageload speeds a lot.


 * Since 1.17, 117>Special:MyLanguage/MediaWiki 1.17/Category sorting</>|category sorting makes sense! (especially for non-English letters); extended to 68 languages after <tvar|121></>.


 * Since <tvar|118></> and <tvar|119></>, users of all languages and genders are correctly addressed by the interface and meta-logs>m:Help:Special_page#Logs</>|logs (before 1.15, no gender at all).


 * In <tvar|119></> the skinning system was reworked making it easier to reuse parts of existing skins in your own skins.


 * Since 1.20, meta-diff>m:Help:Diff</>|diffs are more readable.


 * In 1.21 and 1.23, email notifications become clearer and more predictable, making your wiki more effective.


 * Since 1.22, vandal fighting (patrolling) is less time-consuming.


 * In 1.24, password storage was improved to allow for better security.


 * Since 1.25, enhanced recent changes are available


 * In 1.26, the "ResourceLoader" mechanism was improved


 * In 1.27, the session management was reworked as well as the user authentication management completely modernized.


 * Since 1.29, the Action API was reworked and improved. Also user group assignments may now be done for a selectable period.

Also, in MediaWiki 1.18 we started suggestions>Special:MyLanguage/Suggestions for extensions to be integrated</>|bundling some vital extensions, like a better editor and anti-vandalism tools ConfirmEdit and Nuke; more have been added in later releases. <section end=FAQ />