X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=UPGRADING;h=ce951d1147cff891b2cdd1ab78cdf0d587ca1151;hb=48e244a464574aa732ef5ab3fe759f1e05665b3d;hp=4f4d0da01abba3d6ce6a9cc8a40b2e79fb97b3f8;hpb=8cef237ae639ac176c8296788ce7763ed6cbbc91;p=roundcube.git diff --git a/UPGRADING b/UPGRADING index 4f4d0da..ce951d1 100644 --- a/UPGRADING +++ b/UPGRADING @@ -1,153 +1,54 @@ -UPDATE instructions -=================== +UPGRADING instructions +====================== Follow these instructions if upgrading from a previous version -of RoundCube Webmail. - - -from version 1.0-beta2 ----------------------------------------- -* replace index.php -* replace all files in folder /program/ -* replace all files in folder /skins/default/ -* run all commands in SQL/*.update.sql or re-initalize database with *.initial.sql -* add these lines to /config/main.inc.php - $rcmail_config['draft_autosave'] = 300; - $rcmail_config['date_today'] = 'H:i'; -* If you have LDAP servers configured, change prop key 'mail_field' - to 'email_field' for each server confgured in /config/main.inc.php - - -form version 0.1-beta ----------------------------------------- -* replace index.php -* replace all files in folder /program/ -* replace all files in folder /skins/default/ -* run all commands in SQL/*.update.sql or re-initalize database with *.initial.sql -* add these line to /config/db.inc.php - $rcmail_config['db_persistent'] = TRUE; -* add these lines to /config/main.inc.php - $rcmail_config['drafts_mbox'] = 'Drafts'; - $rcmail_config['junk_mbox'] = 'Junk'; - $rcmail_config['product_name'] = 'RoundCube Webmail'; - $rcmail_config['read_when_deleted'] = TRUE; - $rcmail_config['enable_spellcheck'] = TRUE; - $rcmail_config['protect_default_folders'] = TRUE; - $rcmail_config['draft_autosave'] = 300; - $rcmail_config['date_today'] = 'H:i'; -* replace the following line from /config/main.inc.php - @include($_SERVER['HTTP_HOST'].'.inc.php'); - with - $rcmail_config['include_host_config'] = TRUE; - - - -from version 0.1-20051021 ----------------------------------------- -* replace index.php -* replace all files in folder /program/ -* replace all files in folder /skins/default/ -* run all commands in SQL/*.update-0.1a.sql or re-initalize database with *.initial.sql -* add these lines to /config/main.inc.php - $rcmail_config['skip_deleted'] = FALSE; - $rcmail_config['message_sort_col'] = 'date'; - $rcmail_config['message_sort_order'] = 'DESC'; - $rcmail_config['log_dir'] = 'logs/'; - $rcmail_config['temp_dir'] = 'temp/'; - $rcmail_config['message_cache_lifetime'] = '10d'; - $rcmail_config['drafts_mbox'] = 'Drafts'; - $rcmail_config['product_name'] = 'RoundCube Webmail'; - $rcmail_config['read_when_deleted'] = TRUE; - $rcmail_config['enable_spellcheck'] = TRUE; -* add these lines to /config/db.inc.php - $rcmail_config['db_max_length'] = 512000; - $rcmail_config['db_sequence_user_ids'] = 'user_ids'; - $rcmail_config['db_sequence_identity_ids'] = 'identity_ids'; - $rcmail_config['db_sequence_contact_ids'] = 'contact_ids'; - $rcmail_config['db_sequence_cache_ids'] = 'cache_ids'; - $rcmail_config['db_sequence_message_ids'] = 'message_ids'; - $rcmail_config['db_persistent'] = TRUE; - - - -from version 0.1-20051007 ----------------------------------------- -* replace index.php -* replace all files in folder /program/ -* replace all files in folder /skins/default/ -* run all commands in SQL/*.update-0.1a.sql or re-initalize database with *.initial.sql -* add these lines to /config/main.inc.php - $rcmail_config['smtp_auth_type'] = ''; // if you need to specify an auth method for SMTP - $rcmail_config['session_lifetime'] = 20; // to specify the session lifetime in minutes - $rcmail_config['skip_deleted'] = FALSE; - $rcmail_config['message_sort_col'] = 'date'; - $rcmail_config['message_sort_order'] = 'DESC'; - $rcmail_config['log_dir'] = 'logs/'; - $rcmail_config['temp_dir'] = 'temp/'; - $rcmail_config['message_cache_lifetime'] = '10d'; - $rcmail_config['drafts_mbox'] = 'Drafts'; - $rcmail_config['product_name'] = 'RoundCube Webmail'; - $rcmail_config['read_when_deleted'] = TRUE; - $rcmail_config['enable_spellcheck'] = TRUE; -* add these lines to /config/db.inc.php - $rcmail_config['db_max_length'] = 512000; - $rcmail_config['db_sequence_user_ids'] = 'user_ids'; - $rcmail_config['db_sequence_identity_ids'] = 'identity_ids'; - $rcmail_config['db_sequence_contact_ids'] = 'contact_ids'; - $rcmail_config['db_sequence_cache_ids'] = 'cache_ids'; - $rcmail_config['db_sequence_message_ids'] = 'message_ids'; - $rcmail_config['db_persistent'] = TRUE; - - - -from version 0.1-20050820 ----------------------------------------- -* replace index.php -* replace all files in folder /program/ -* replace all files in folder /skins/default/ -* run all commands in SQL/*.update-0.1a.sql or re-initalize database with *.initial.sql -* add these line to /config/main.inc.php - $rcmail_config['prettydate'] = TRUE; - $rcmail_config['smtp_port'] = 25; - $rcmail_config['default_port'] = 143; - $rcmail_config['session_lifetime'] = 20; - $rcmail_config['skip_deleted'] = FALSE; - $rcmail_config['message_sort_col'] = 'date'; - $rcmail_config['message_sort_order'] = 'DESC'; - $rcmail_config['log_dir'] = 'logs/'; - $rcmail_config['temp_dir'] = 'temp/'; - $rcmail_config['message_cache_lifetime'] = '10d'; -* replace database properties (db_type, db_host, db_user, db_pass, $d_name) - in /config/db.inc.php with the following line: - $rcmail_config['db_dsnw'] = 'mysql://roundcube:pass@localhost/roundcubemail'; -* add these lines to /config/db.inc.php - $rcmail_config['db_max_length'] = 512000; - - - -from versions 0.1-alpha and 0.1-20050811 ----------------------------------------- -* replace index.php -* replace all files in folder /program/ -* replace all files in folder /skins/default/ -* run all commands in SQL/*.update-0.1a.sql or re-initalize database with *.initial.sql -* add these line to /config/main.inc.php - $rcmail_config['trash_mbox'] = 'Trash'; - $rcmail_config['default_imap_folders'] = array('INBOX', 'Drafts', 'Sent', 'Junk', 'Trash'); - $rcmail_config['prefer_html'] = TRUE; - $rcmail_config['prettydate'] = TRUE; - $rcmail_config['smtp_port'] = 25; - $rcmail_config['default_port'] = 143; - $rcmail_config['session_lifetime'] = 20; - $rcmail_config['skip_deleted'] = FALSE; - $rcmail_config['message_sort_col'] = 'date'; - $rcmail_config['message_sort_order'] = 'DESC'; - $rcmail_config['log_dir'] = 'logs/'; - $rcmail_config['temp_dir'] = 'temp/'; - $rcmail_config['message_cache_lifetime'] = '10d'; -* replace database properties (db_type, db_host, db_user, db_pass, $d_name) - in /config/db.inc.php with the following line: - $rcmail_config['db_dsnw'] = 'mysql://roundcube:pass@localhost/roundcubemail'; -* add these lines to /config/db.inc.php - $rcmail_config['db_max_length'] = 512000; - +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 + +For 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. + +Please also see Post-Upgrade Activities section. + + +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/ + - ./skins/default/ + - ./plugins/ +2. 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. +3. Let the update script/installer check your configuration and + update your config files and database schema as suggested by the updater. +4. Make sure 'enable_installer' is set to false again. +5. 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.