summaryrefslogtreecommitdiff
path: root/webmail/UPGRADING
diff options
context:
space:
mode:
Diffstat (limited to 'webmail/UPGRADING')
-rw-r--r--webmail/UPGRADING65
1 files changed, 65 insertions, 0 deletions
diff --git a/webmail/UPGRADING b/webmail/UPGRADING
new file mode 100644
index 0000000..03d5499
--- /dev/null
+++ b/webmail/UPGRADING
@@ -0,0 +1,65 @@
+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 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.
+
+WARNING: See Post-Upgrade Activities section below.
+
+
+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/
+ - ./SQL/
+ - ./program/
+2. rsync the contents of the following folders from your installation
+ directory into the target folder:
+ ./skins/
+ ./plugins/
+3. 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.
+ WARNING: See SQLite database upgrade below.
+4. Let the update script/installer check your configuration and
+ update your config files and database schema as suggested by the updater.
+5. Make sure 'enable_installer' is set to false again.
+6. 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.
+4. Check system requirements in INSTALL file.
+
+SQLite database upgrade
+-----------------------
+Versions older than 0.9 were supporting SQLite v2 only. Newer versions require
+database in v3 format. The best what you can do is to convert database file
+to the new format using command line tools:
+
+sqlite OLD.DB .dump | sqlite3 NEW.DB