Document what settings are disabled by $wgHtml5
[lhc/web/wiklou.git] / UPGRADE
diff --git a/UPGRADE b/UPGRADE
index 77168ac..b7be613 100644 (file)
--- a/UPGRADE
+++ b/UPGRADE
@@ -1,3 +1,4 @@
+
 This file provides an overview of the MediaWiki upgrade process. For help with
 specific problems, check
 
@@ -42,25 +43,45 @@ You can also obtain the new files directly from our Subversion source code
 repository, via a checkout or export operation.
 
 Replace the existing MediaWiki files with the new. You should preserve the
-LocalSettings.php file, AdminSettings.php file (if present), and the
-"extensions" and "images" directories.
+LocalSettings.php file and the "extensions" and "images" directories.
 
 Depending upon your configuration, you may also need to preserve additional
 directories, including a custom upload directory ($wgUploadDirectory),
-deleted file archives, and any custom skins.  If you're using very old exten-
-sions that add files to the "includes" directory or other directories, be sure
-to back those up as well.
+deleted file archives, and any custom skins.
 
 === Perform the database upgrade ===
 
-You will need an AdminSettings.php file set up in the correct format; see
-AdminSettings.sample in the wiki root for more information and examples.
+You will need to have $wgDBadminuser and $wgDBadminpassword set in your
+LocalSettings.php, see there for more info.
+
+==== From the web ====
+
+You will need to set $wgUpgradeKey in your LocalSettings.php in order to use
+the updater.
+
+If you browse to the web-based installation script (usually at /config/index.php)
+from your wiki installation you can follow the script and upgrade your database
+in place.
+
+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.
+
+==== 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.
 
+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.
+
 === Check configuration settings ===
 
 The names of configuration variables, and their default values and purposes,
@@ -69,6 +90,12 @@ with $wgEnableUploads in later versions. When upgrading, consult the release
 notes to check for configuration changes which would alter the expected
 behaviour of MediaWiki.
 
+=== Check installed extensions ===
+
+In MediaWiki 1.14 some extensions are migrated into the core. Please see the
+HISTORY section "Migrated extensions" and disable these extensions in your
+LocalSettings.php
+
 === Test ===
 
 It makes sense to test your wiki immediately following any kind of maintenance
@@ -92,10 +119,8 @@ 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 ==
 
 $wgDefaultUserOptions now contains all the defaults, not only overrides.
@@ -105,9 +130,6 @@ to set only specific items as recommended in DefaultSettings.php.
 == Upgrading from 1.6 wikis ==
 
 $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 ==
 
@@ -165,34 +187,6 @@ 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 (and AdminSettings.php, if any) files; 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 create an AdminSettings.php giving 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!
@@ -216,17 +210,8 @@ option to 'latin1' to avoid the conversion.
 For general help on pg_dump:
 http://www.postgresql.org/docs/current/static/app-pgdump.html
 
-
 == 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 ===
 
 1.4.3 has added new fields to the sitestats table. These fields are
@@ -270,19 +255,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