More robust directory structure migration, should fix bug #2532, except for Brion...

[lhc/web/wiklou.git] / UPGRADE

diff --git a/UPGRADE b/UPGRADE
index 4449ffa..ece64ec 100644 (file)
--- a/UPGRADE
+++ b/UPGRADE
@@ -14,7 +14,69 @@ Basically, to upgrade a wiki you:
   great, but it should work to extract over the old files too. This may
   be easier if you have images etc in place and don't want to move them
   around, but remember to back up first!
-* Run the installer to upgrade the database schema (if necessary).
+* Run the installer to upgrade the database schema (if necessary,
+  see sections below for details).
+
+
+== IMPORTANT: Upgrading to 1.5 ==
+
+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.
+
+DO NOT ATTEMPT TO UPGRADE A LIVE, PUBLIC SITE TO 1.5 AT THIS TIME.
+NEVER EVER ATTEMPT TO PERFORM AN UPGRADE WITHOUT BACKING UP FIRST!
+
+On a large site, the schema update might take a long time. It might
+explode, or leave your database half-done or otherwise badly hurting.
+
+Among other changes, note that Latin-1 encoding (ISO-8859-1) is
+no longer supported. Latin-1 wikis will need to be upgraded to
+UTF-8; an experimental command-line upgrade helper script,
+'upgrade1_5.php', can do this -- run it prior to 'update.php' or
+the web upgrader.
+
+If you absolutely cannot make the UTF-8 upgrade work, you can try
+doing it by hand: dump your old database, convert the dump file
+using iconv as described here: 
+http://portal.suse.com/sdb/en/2004/05/jbartsh_utf-8.html
+and then reimport it. You can also convert filenames using convmv,
+but note that the old directory hashes will no longer be valid,
+so you will also have to move them to new destinations.
+
+Message changes:
+* A number of additional UI messages have been chagned from HTML to
+  wikitext, and will need to be manually fixed if customized.
+
+
+=== Configuration changes from 1.4.x: ===
+
+$wgDisableUploads has been replaced with $wgEnableUploads.
+
+$wgWhitelistAccount has been replaced by the 'createaccount' permission
+key in $wgGroupPermissions. To emulate the old effect of setting:
+  $wgWhitelistAccount['user'] = 0;
+set:
+  $wgGroupPermissions['*']['createaccount'] = false;
+
+$wgWhitelistEdit has been replaced by the 'edit' permission key.
+To emulate the old effect of setting:
+  $wgWhitelistEdit = true;
+set:
+  $wgGroupPermissions['*']['edit'] = false;
+
+If $wgWhitelistRead is set, you must also disable the 'read' permission
+for it to take affect on anonymous users:
+  $wgWhitelistRead = array( "Main Page", "Special:Userlogin" );
+  $wgGroupPermissions['*']['read'] = false;
+
+Note that you can disable/enable several other permissions by modifying
+this configuration array in your LocalSettings.php; see DefaultSettings.php
+for the complete default permission set.
+
+If using Memcached, you must enabled it differently now:
+  $wgUseMemCached = true;
+should be replaced with:
+  $wgMainCacheType = CACHE_MEMCACHED;
 
 
 === Web installer ===
@@ -68,6 +130,7 @@ http://mail.wikipedia.org/pipermail/wikitech-l/2004-November/026359.html
 
 == Caveats ==
 
+
 === Upgrading from 1.4.2 or earlier ===
 
 1.4.3 has added new fields to the sitestats table. These fields are