UPGRADING

   1 UPGRADING instructions
   2 ======================
   3
   4 Follow these instructions if upgrading from a previous version
   5 of Roundcube Webmail. We recommend to carefully backup the existing
   6 installation as well as the database before going through the following steps.
   7
   8 Using the update script
   9 -----------------------
  10 There is a shell script (for unix based systems) that does the job for you.
  11 To use it, unpack the archive of the new Roundcube version to a temporary location
  12 (don't replace the Roundcube installation you want to update)
  13 and cd into that directory. From there, run the following command in a shell:
  14
  15   ./bin/installto.sh <TARGET-FOLDER>
  16
  17 For <TARGET-FOLDER> you specify the path to the Roundcube installation
  18 which should be updated. The update script will then copy all new files to the
  19 target location and check and update the configuration and database schema.
  20 After all is done, the temporary folder with the new Roundcube files can be
  21 removed again.
  22
  23 Please also see Post-Upgrade Activities section.
  24
  25
  26 Updating manually
  27 -----------------
  28 If you don't have shell access to the Roundcube installation or if not running
  29 it on a unix system, you need to do the following operations by hand:
  30
  31 1. Replace index.php and all files in
  32    - ./bin/
  33    - ./SQL/
  34    - ./program/
  35 2. rsync the contents of the following folders from your installation
  36    directory into the target folder:
  37    ./skins/
  38    ./plugins/
  39 3. Run ./bin/update.sh from the commandline OR
  40    open http://url-to-roundcube/installer/ in a browser and choose "3 Test config".
  41    To enable the latter one, you have to temporary set 'enable_installer'
  42    to true in your local config/main.inc.php file.
  43 4. Let the update script/installer check your configuration and
  44    update your config files and database schema as suggested by the updater.
  45 5. Make sure 'enable_installer' is set to false again.
  46 6. See Post-Upgrade Activities section.
  47
  48
  49 Post-Upgrade Activities
  50 -----------------------
  51 1. Check .htaccess settings (some php settings could become required)
  52 2. If you're using build-in addressbook, run indexing script /bin/indexcontacts.sh.
  53 3. When upgrading from version older than 0.6-beta you should make sure
  54    your folder settings contain namespace prefix. For example Courier users
  55    should add INBOX. prefix to folder names in main configuration file.