path: root/UPGRADE
diff options
authorPierre Schmitz <>2011-06-22 11:28:20 +0200
committerPierre Schmitz <>2011-06-22 11:28:20 +0200
commit9db190c7e736ec8d063187d4241b59feaf7dc2d1 (patch)
tree46d1a0dee7febef5c2d57a9f7b972be16a163b3d /UPGRADE
parent78677c7bbdcc9739f6c10c75935898a20e1acd9e (diff)
update to MediaWiki 1.17.0
Diffstat (limited to 'UPGRADE')
1 files changed, 49 insertions, 94 deletions
diff --git a/UPGRADE b/UPGRADE
index 7cd302e9..9e7d0353 100644
@@ -1,3 +1,4 @@
This file provides an overview of the MediaWiki upgrade process. For help with
specific problems, check
@@ -28,7 +29,7 @@ the upgrade scripts are somewhat robust, there is no guarantee that things will
not fail, leaving the database in an inconsistent state. provides an overview of
-the upgrade process. You should also refer to the documentation for your
+the backup process. You should also refer to the documentation for your
database management system for information on backing up a database, and to
your operating system documentation for information on making copies of files.
@@ -50,10 +51,15 @@ deleted file archives, and any custom skins.
=== Perform the database upgrade ===
-You will need to have $wgDBadminuser and $wgDBadminpassword set in your
-LocalSettings.php, see there for more info.
+==== From the web ====
+If you browse to the web-based installation script (usually at
+/mw-config/index.php) from your wiki installation you can follow the script and
+upgrade your database in place.
+==== From the command line ====
-From the command line, browse to the "maintenance" directory and run the
+From the command line, browse to the "maintenance" directory and run the
update.php script to check and update the schema. This will insert missing
tables, update existing tables, and move data around as needed. In most cases,
this is successful and nothing further needs to be done.
@@ -67,6 +73,9 @@ notes to check for configuration changes which would alter the expected
behaviour of MediaWiki.
=== Check installed extensions ===
+Extensions usually need to be upgraded at the same time as the MediaWiki core.
In MediaWiki 1.14 some extensions are migrated into the core. Please see the
HISTORY section "Migrated extensions" and disable these extensions in your
@@ -80,7 +89,17 @@ and quirks which reveal themselves.
You should also test any extensions, and upgrade these if necessary.
-== Upgrading from 1.8 wikis ==
+== Upgrading from 1.16 or earlier ==
+If you have a Chinese or Japanese wiki ($wgLanguageCode is set to one
+of "zh", "ja", or "yue") and you are using MySQL fulltext search, you
+will probably want to update the search index.
+In the "maintenance" directory, run the updateDoubleWidthSearch.php
+script. This will update the searchindex table for those pages that
+contain double-byte latin characters.
+== Upgrading from 1.8 or earlier ==
MediaWiki 1.9 and later no longer keep default localized message text
in the database; 'MediaWiki:'-namespace pages that do not exist in the
@@ -94,24 +113,19 @@ Note that the large number of deletions may cause older edits to expire
from the list on Special:Recentchanges, although the deletions themselves
will be hidden by default. (Click "show bot edits" to list them.)
See RELEASE-NOTES for more details about new and changed options.
-== Upgrading from 1.7 wikis ==
+== Upgrading from 1.7 or earlier ==
$wgDefaultUserOptions now contains all the defaults, not only overrides.
If you're setting this as a complete array(), you may need to change it
to set only specific items as recommended in DefaultSettings.php.
-== Upgrading from 1.6 wikis ==
+== Upgrading from 1.6 or earlier ==
$wgLocalTZoffset was in hours, it is now using minutes.
-Link autonumbering got fixed (#5918) for protocols other than http.
- - 'irc://irc.server.tld/' render as a link with a chat icon
- - '[irc://irc.server.tld]' render as an autonumbered link: [1]
-== Upgrading from pre-1.5 wikis ==
+== Upgrading from 1.5 or earlier ==
Major changes have been made to the schema from 1.4.x. The updater
has not been fully tested for all conditions, and might well break.
@@ -167,69 +181,7 @@ If using Memcached, you must enabled it differently now:
should be replaced with:
$wgMainCacheType = CACHE_MEMCACHED;
-=== Web installer ===
-You can use the web-based installer wizard if you first remove the
-LocalSettings.php file; be sure to give the installer the same
-information as you did on the original install (language/encoding,
-database name, password, etc). This will also generate a fresh
-LocalSettings.php, which you may need to customize.
-You may change some settings during the install, but be very careful!
-Changing the encoding in particular will generally leave you with a
-lot of corrupt pages, particularly if your wiki is not in English.
-=== Command-line upgrade ===
-Additionally, as of 1.4.0 you can run an in-place upgrade script from
-the command line, keeping your existing LocalSettings.php. This requires
-that you set $wgDBadminuser and $wgDBadminpassword with an appropriate
-database user and password with privileges to modify the database structure.
-Once the new files are in place, go into the maintenance subdirectory and
-run the script:
- php update.php
-See caveats below on upgrading from 1.3.x or earlier.
-== Backups! ==
-To upgrade an existing MediaWiki installation, first BACK UP YOUR WIKI!
-If something goes wrong, you want to be able to start again.
-Your image files, configuration, etc can simply be copied or archived as
-you would any other files. (Make sure that the contents of your
-LocalSettings.php are not accidentally made public, as this contains
-a database password.)
-To back up the database, use the tools provided by your service provider
-(if applicable) or the standard mysqldump or pg_dump programs.
-For general help on mysqldump:
-WARNING: If using MySQL 4.1.x, mysqldump's charset conversion may in
-some cases damage data in your wiki. If necessary, set the charset
-option to 'latin1' to avoid the conversion.
-For general help on pg_dump:
-== Caveats ==
-=== Postgres ===
-Postgres support is new, and much of the upgrade instructions may
-not apply. The schema was changed significantly from 1.7 to 1.8,
-so you will need to at least use the update.php or web installer,
-as described above.
-=== Upgrading from 1.4.2 or earlier ===
+== Upgrading from 1.4.2 or earlier ==
1.4.3 has added new fields to the sitestats table. These fields are
optional and help to speed Special:Statistics on large sites. If you
@@ -241,7 +193,7 @@ manually run the SQL commands from this file:
-=== Upgrading from 1.4rc1 or earlier betas ===
+== Upgrading from 1.4rc1 or earlier betas ==
The logging table has been altered from 1.4beta4 to 1.4beta5
and again in 1.4.0 final. Copy in the new files and use the web
@@ -254,7 +206,7 @@ files:
-=== Upgrading from 1.3.x ===
+== Upgrading from 1.3 or earlier ==
This should generally go smoothly.
@@ -272,19 +224,20 @@ to this:
As well as new messages, the processing of some messages has changed.
If you have customized them, please compare the new format using
Special:Allmessages or the relevant LanguageXX.php files:
- copyrightwarning
- dberrortext
- editingcomment (was named commentedit)
- editingsection (was named sectionedit)
- numauthors
- numedits
- numtalkauthors
- numtalkedits
- numwatchers
- protectedarticle
- searchresulttext
- showhideminor
- unprotectedarticle
+* copyrightwarning
+* dberrortext
+* editingcomment (was named commentedit)
+* editingsection (was named sectionedit)
+* numauthors
+* numedits
+* numtalkauthors
+* numtalkedits
+* numwatchers
+* protectedarticle
+* searchresulttext
+* showhideminor
+* unprotectedarticle
Note that the 1.3 beta releases included a potential vulnerability if PHP
is configured with register_globals on and the includes directory is
@@ -296,7 +249,7 @@ send them a kind note explaining that it can expose their servers and their
customers to attacks.
-=== Upgrading from 1.2.x ===
+== Upgrading from 1.2 or earlier ==
If you've been using the MediaWiki: namespace for custom page templates,
note that things are a little different. The Template: namespace has been
@@ -316,7 +269,7 @@ to dump the database to SQL, run it through iconv or another conversion tool,
and restore it. Sorry.
-=== Upgrading from 1.1.x or earlier ===
+== Upgrading from 1.1 or earlier ==
This is less thoroughly tested, but should work.
@@ -330,7 +283,7 @@ scripts in maintenance/archives before the installer is able to pick up
with remaining updates.
-=== Upgrading from UseModWiki or old "phase 2" Wikipedia code ===
+== Upgrading from UseModWiki or old "phase 2" Wikipedia code ==
There is a semi-maintained UseModWiki to MediaWiki conversion script at
maintenance/importUseModWiki.php; it may require tweaking and customization
@@ -341,3 +294,5 @@ output SQL statements; direct these to a file and then run that into your
You will have to rebuild the links tables etc after importing.