View source for Manual:Upgrading to 1.7

{{languages}}
{{Historical}}
{{Oldupgradenotes}}

<div style="border:1px solid #f3f3ff; padding-left: 0.5em !important; background-color: #f3f3ff; border-width: 0 0 0 1.4em; clear:right; float:right;">
{{MW quick download}}
</div>

Furtive poking, whispered mutterings and an intense amount of sweat, blood and tears have produced the new MediaWiki 1.7 release branch, which introduces several new requirements and a wealth of new features and fixes.

So how to start with upgrading? This guide should help users of the 1.6 release branch migrate to MediaWiki 1.7 in a smooth fashion. It will also work for users of the obsolete 1.5 branch.

== Overview ==

First, [http://svn.wikimedia.org/viewvc/mediawiki/branches/REL1_7/phase3/UPGRADE?view=markup read the UPGRADE text file included in MediaWiki 1.7].

As with all MediaWiki upgrades, the basic premise is the same:

# Check the requirements
# Read the release notes
# Back up existing files and the database
# Unpack the new files
# Run the update script to check the database
# Upgrade extensions
# Test the update

== Check requirements ==

MediaWiki 1.7 requires:

* '''PHP 5.0 or later'''
*: Older versions will no longer work

* '''MySQL 4.0 or later'''
*: MySQL 3.x has not been supported since 1.6

== Read the release notes ==

Within the distribution tarball, or within the files checked out/exported from SVN, there are a number of files with capitalised filenames, one of which contains the '''<code>[http://svn.wikimedia.org/viewvc/mediawiki/tags/REL1_7_0/phase3/RELEASE-NOTES RELEASE-NOTES]</code>'''. Now's the time to open it up and find out what's been changed in 1.7.

== Back up existing files and the database ==

While the upgrade scripts are well-maintained and robust, things could still go pear-shaped. Before proceeding to update the database schema, '''make a full backup''' of the wiki, including both the database and the files.

=== Database ===

Make a full backup of the wiki database before attempting to run update scripts on it. This serves as a basic precaution should the schema updates fail, leaving records in a broken or corrupt state. There are a number of utilities to do this, such as [http://dev.mysql.com/doc/refman/5.0/en/mysqldump.html MySQL dump], which is supplied with the MySQL software.

=== Settings ===

Make a copy of your <code>'''LocalSettings.php'''</code> file, which contains both the basic configuration details, and also any customisations you may have made to change the behaviour of MediaWiki.

=== Uploaded files ===

If uploads are enabled in the wiki, then you will also need to back up the upload directory. By default, this is the <code>'''images'''</code> directory, although the path to this may have been changed in <code>'''LocalSettings.php'''</code>.

=== Extensions and custom skins ===

Take copies of the <code>'''extensions'''</code> directory, and any files or directories containing skin customisations.

== Unpack the new files ==

If using a tarball package [[Download|downloaded from SourceForge]], decompress it; if using [[Download from SVN|Subversion]], export the files into a clean location. Replace all existing files with the new versions from 1.7, preserving the directory structure. The core code is now up to date.

== Run the update script ==

'''Note:''' Make sure there's an <code>'''AdminSettings.php'''</code> file in the wiki root, and it's got up to date information in it. The user needs full permissions on the database.

The preferred method of performing the update is using the command-line maintenance script, however, it is also possible to re-run the web-based installer.

=== Shell ===

From the command line, or an SSH shell or similar, change to the <code>'''maintenance'''</code> directory and execute the update script:

 $ php update.php

MediaWiki will inspect the existing schema and update it to work with the new code, adding tables and columns as needed. If upgrading from 1.5.x, once this is complete, you are advised to run the <code>'''refreshLinks.php'''</code> script to update the link tables.

==== Alternative: phpShell ====

If shell access is not available, look at options such as [http://www.mgeisler.net/php-shell phpShell], which emulates a command prompt using PHP functions. This might not work on some locked-down hosting setups.

When using such a solution, it is often desirable to skip the countdown period at the start of the script. Pass the <code>'''--quick'''</code> option to the update script to do so:

 $ php update.php --quick

=== Re-run the installer ===

An alternative to running the update script from the shell is to re-run the web installer. To do this:

# Rename <code>'''LocalSettings.php'''</code> to <code>'''LocalSettings.php.old'''</code>
# Make the <code>'''config'''</code> directory writable by the web server
# Browse to the wiki and start the installer

Fill in the form fields with the same values as was done during the previous version's installation. When the installation process starts, the script will detect existing MediaWiki tables, and upgrade their schema. When this is complete, a new <code>'''LocalSettings.php'''</code> will be generated.

# Delete the new configuration file
# Rename <code>'''LocalSettings.php.old'''</code> back to <code>'''LocalSettings.php'''</code>
# Restore permissions on the <code>'''config'''</code> directory

== Upgrade extensions ==

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

== Test the update==

Once the upgrade has completed, browse to the wiki and check basics such as viewing and editing pages to ensure things still work as expected. Visit [[Special:Version]] and check that the version shown is correct.

== Links ==

Upgradings documents for other versions:

* [[Manual:Upgrading to 1.6]]
* [[Manual:Upgrading to 1.8]]

[[Category:MediaWiki development{{#translation:}}|Upgrading to 1.07]]
[[Category:Upgrading{{#translation:}}|Upgrading to 1.07]]