Mercurial > hg > rc1
diff UPGRADING @ 0:1e000243b222
vanilla 1.3.3 distro, I hope
author | Charlie Root |
---|---|
date | Thu, 04 Jan 2018 15:50:29 -0500 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/UPGRADING Thu Jan 04 15:50:29 2018 -0500 @@ -0,0 +1,82 @@ +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/ + - ./installer/ +2. Replace the configuration defaults files: + - config/defaults.inc.php + - config/mimetypes.php +3. rsync the contents of the following folders from your installation + directory into the target folder: + ./skins/ + ./plugins/ + ./vendor/ +4. Update dependencies: +4a. If you previously installed plugins through composer, update dependencies + by running `php composer.phar update --no-dev`. +4b. Install/update dependencies using composer: + - get composer from https://getcomposer.org/download/ + - rename the composer.json-dist file into composer.json + - if you want to use LDAP address books, enable the LDAP libraries in your + composer.json file by moving the items from "suggest" to the "require" + section (remove the explanation texts after the version!). + - run `php composer.phar install --no-dev`. +4c. If you use git sources or the release package without dependencies + update javascript dependencies by executing `bin/install-jsdeps.sh` script. +5. 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/config.inc.php file. + WARNING: See SQLite database upgrade below. +6. Let the update script/installer check your configuration and + update your config files and database schema as suggested by the updater. +7. Make sure 'enable_installer' is set to false again. +8. 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