Aleksander Machniak
2014-12-29 dc684a737a062bb738f91d844e0700ce59d332a1
commit | author | age
a2451c 1 UPGRADING instructions
T 2 ======================
4e17e6 3
2491c6 4 Follow these instructions if upgrading from a previous version
T 5 of Roundcube Webmail. We recommend to carefully backup the existing
111a6f 6 installation as well as the database before going through the following steps.
4e17e6 7
e6bb83 8 Using the update script
T 9 -----------------------
10 There is a shell script (for unix based systems) that does the job for you.
111a6f 11 To use it, unpack the archive of the new Roundcube version to a temporary location
A 12 (don't replace the Roundcube installation you want to update)
e6bb83 13 and cd into that directory. From there, run the following command in a shell:
T 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.
faf10e 22
738996 23 WARNING: See Post-Upgrade Activities section below.
e6bb83 24
T 25
26 Updating manually
27 -----------------
111a6f 28 If you don't have shell access to the Roundcube installation or if not running 
e6bb83 29 it on a unix system, you need to do the following operations by hand:
T 30
0089fd 31 1. Replace index.php and all files in
T 32    - ./bin/
33    - ./SQL/
34    - ./program/
6d1e31 35    - ./installer/
TB 36 2. Replace the configuration defaults files:
37    - config/defaults.inc.php
38    - config/mimetypes.php
39 3. rsync the contents of the following folders from your installation
9efa95 40    directory into the target folder:
T 41    ./skins/
42    ./plugins/
d4a820 43    ./vendor/
0c137f 44 4. Run `./bin/update.sh` from the commandline OR
2491c6 45    open http://url-to-roundcube/installer/ in a browser and choose "3 Test config".
e6bb83 46    To enable the latter one, you have to temporary set 'enable_installer'
461a30 47    to true in your local config/config.inc.php file.
001b17 48    WARNING: See SQLite database upgrade below.
6d1e31 49 5. Let the update script/installer check your configuration and
e6bb83 50    update your config files and database schema as suggested by the updater.
d4a820 51 5. If you previously installed plugins through composer, update dependencies
TB 52    by running `php composer.phar update --no-dev`
0c137f 53 7. Make sure 'enable_installer' is set to false again.
TB 54 8. See Post-Upgrade Activities section.
0089fd 55
T 56
111a6f 57 Post-Upgrade Activities
A 58 -----------------------
59 1. Check .htaccess settings (some php settings could become required)
60 2. If you're using build-in addressbook, run indexing script /bin/indexcontacts.sh.
d08333 61 3. When upgrading from version older than 0.6-beta you should make sure
A 62    your folder settings contain namespace prefix. For example Courier users
63    should add INBOX. prefix to folder names in main configuration file.
738996 64 4. Check system requirements in INSTALL file.
001b17 65
AM 66 SQLite database upgrade
67 -----------------------
68 Versions older than 0.9 were supporting SQLite v2 only. Newer versions require
69 database in v3 format. The best what you can do is to convert database file
70 to the new format using command line tools:
71
72 sqlite OLD.DB .dump | sqlite3 NEW.DB