Imported Upstream version 0.6+dfsg

[roundcube.git] / UPGRADING

diff --git a/UPGRADING b/UPGRADING
index 329983d377e54aa36cef364323cf4ba0113c01a6..ce951d1147cff891b2cdd1ab78cdf0d587ca1151 100644 (file)
--- a/UPGRADING
+++ b/UPGRADING
@@ -3,7 +3,30 @@ UPGRADING instructions
 
 Follow these instructions if upgrading from a previous version
 of Roundcube Webmail. We recommend to carefully backup the existing
-installation as well as the database before executig the following steps.
+installation as well as the database before going through the following steps.
+
+Using the update script
+-----------------------
+There is a shell script (for unix based systems) that does the job for you.
+To use it, unpack the archive of the new Roundcube version to a temporary location
+(don't replace the Roundcube installation you want to update)
+and cd into that directory. From there, run the following command in a shell:
+
+  ./bin/installto.sh <TARGET-FOLDER>
+
+For <TARGET-FOLDER> you specify the path to the Roundcube installation 
+which should be updated. The update script will then copy all new files to the 
+target location and check and update the configuration and database schema.
+After all is done, the temporary folder with the new Roundcube files can be 
+removed again.
+
+Please also see Post-Upgrade Activities section.
+
+
+Updating manually
+-----------------
+If you don't have shell access to the Roundcube installation or if not running 
+it on a unix system, you need to do the following operations by hand:
 
 1. Replace index.php and all files in
    - ./bin/
@@ -14,14 +37,18 @@ installation as well as the database before executig the following steps.
    - ./plugins/
 2. Run ./bin/update.sh from the commandline OR
    open http://url-to-roundcube/installer/ in a browser and choose "3 Test config".
-   To enable the latter one, you have to temporary set 'enable_installer' to true
-   in your local config/main.inc.php file.
+   To enable the latter one, you have to temporary set 'enable_installer'
+   to true in your local config/main.inc.php file.
 3. Let the update script/installer check your configuration and
-   update your config files as suggested by the updater.
-4. If suggested by the update script, run all commands in
-   ./SQL/[yourdbtype].update.sql that are superscribed with the
-   currently installed version number.
-5. Make sure 'enable_installer' is set to false again.
-6. Check .htaccess settings (some php settings could become required)
+   update your config files and database schema as suggested by the updater.
+4. Make sure 'enable_installer' is set to false again.
+5. See Post-Upgrade Activities section.
 
 
+Post-Upgrade Activities
+-----------------------
+1. Check .htaccess settings (some php settings could become required)
+2. If you're using build-in addressbook, run indexing script /bin/indexcontacts.sh.
+3. When upgrading from version older than 0.6-beta you should make sure
+   your folder settings contain namespace prefix. For example Courier users
+   should add INBOX. prefix to folder names in main configuration file.