|
0
|
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 WARNING: See Post-Upgrade Activities section below.
|
|
|
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 - ./installer/
|
|
|
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
|
|
|
40 directory into the target folder:
|
|
|
41 ./skins/
|
|
|
42 ./plugins/
|
|
|
43 ./vendor/
|
|
|
44 4. Update dependencies:
|
|
|
45 4a. If you previously installed plugins through composer, update dependencies
|
|
|
46 by running `php composer.phar update --no-dev`.
|
|
|
47 4b. Install/update dependencies using composer:
|
|
|
48 - get composer from https://getcomposer.org/download/
|
|
|
49 - rename the composer.json-dist file into composer.json
|
|
|
50 - if you want to use LDAP address books, enable the LDAP libraries in your
|
|
|
51 composer.json file by moving the items from "suggest" to the "require"
|
|
|
52 section (remove the explanation texts after the version!).
|
|
|
53 - run `php composer.phar install --no-dev`.
|
|
|
54 4c. If you use git sources or the release package without dependencies
|
|
|
55 update javascript dependencies by executing `bin/install-jsdeps.sh` script.
|
|
|
56 5. Run `./bin/update.sh` from the commandline OR
|
|
|
57 open http://url-to-roundcube/installer/ in a browser and choose "3 Test config".
|
|
|
58 To enable the latter one, you have to temporary set 'enable_installer'
|
|
|
59 to true in your local config/config.inc.php file.
|
|
|
60 WARNING: See SQLite database upgrade below.
|
|
|
61 6. Let the update script/installer check your configuration and
|
|
|
62 update your config files and database schema as suggested by the updater.
|
|
|
63 7. Make sure 'enable_installer' is set to false again.
|
|
|
64 8. See Post-Upgrade Activities section.
|
|
|
65
|
|
|
66
|
|
|
67 Post-Upgrade Activities
|
|
|
68 -----------------------
|
|
|
69 1. Check .htaccess settings (some php settings could become required)
|
|
|
70 2. If you're using build-in addressbook, run indexing script /bin/indexcontacts.sh.
|
|
|
71 3. When upgrading from version older than 0.6-beta you should make sure
|
|
|
72 your folder settings contain namespace prefix. For example Courier users
|
|
|
73 should add INBOX. prefix to folder names in main configuration file.
|
|
|
74 4. Check system requirements in INSTALL file.
|
|
|
75
|
|
|
76 SQLite database upgrade
|
|
|
77 -----------------------
|
|
|
78 Versions older than 0.9 were supporting SQLite v2 only. Newer versions require
|
|
|
79 database in v3 format. The best what you can do is to convert database file
|
|
|
80 to the new format using command line tools:
|
|
|
81
|
|
|
82 sqlite OLD.DB .dump | sqlite3 NEW.DB
|
