X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=INSTALL;h=ed51b13614fe8d865846176634c3cc3d2d5ad43f;hb=fe4a852cd4335d3d2089b13e10d409fa2fa816d8;hp=d2b9145a07c51898f287f65c11e7802bbeb3256c;hpb=e8a0682b96f5b7f297e58d101735ba20a0cc3a89;p=roundcube.git diff --git a/INSTALL b/INSTALL index d2b9145..ed51b13 100644 --- a/INSTALL +++ b/INSTALL @@ -1,7 +1,7 @@ INTRODUCTION ============ -This file describes the basic steps to install RoundCube Webmail on your +This file describes the basic steps to install Roundcube Webmail on your web server. For additional information, please also consult the project's wiki page at http://trac.roundcube.net/wiki @@ -11,27 +11,31 @@ REQUIREMENTS * The Apache or Lighttpd Webserver * .htaccess support allowing overrides for DirectoryIndex -* PHP Version 5.2 or greater including - - PCRE (perl compatible regular expression) - - DOM (xml document object model) +* PHP Version 5.2.1 or greater including + - PCRE, DOM, JSON, XML, Session, Sockets (required) - Libiconv - Multibyte String (mbstring) - Mcrypt (supporting Triple DES) + - Fileinfo (optional) - Database driver for either MySQL, Postgres or SQLite -* php.ini options: +* The PEAR framework with the following packages installed: + - MDB2 2.5.0 or newer + - Mail_Mime 1.8.1 or newer + - Net_SMTP 1.4.2 or newer + - Auth_SASL 1.0.3 or newer +* php.ini options (see .htaccess file): - error_reporting E_ALL & ~E_NOTICE (or lower) - - memory_limit (increase as suitable to support large attachments) + - memory_limit > 16MB (increase as suitable to support large attachments) - file_uploads enabled (for attachment upload features) - session.auto_start disabled - zend.ze1_compatibility_mode disabled -* The PEAR framework with the following packages installed - - MDB2 (2.5.0b2) - - Mail_Mime (1.5.2) - - Net_SMTP (1.3.3) + - suhosin.session.encrypt disabled + - mbstring.func_overload disabled * PHP compiled with OpenSSL to connect to IMAPS and to use the spell checker -* A MySQL or PostgreSQL database engine or the SQLite extension for PHP +* A MySQL (4.0.8 or newer), PostgreSQL, MSSQL database engine + or the SQLite extension for PHP * One of the above databases with permission to create tables -* An SMTP server or PHP configured for mail delivery +* An SMTP server (recommended) or PHP configured for mail delivery INSTALLATION @@ -42,7 +46,7 @@ INSTALLATION are writable by the webserver - /temp - /logs -3. Create a new database and a database user for RoundCube (see DATABASE SETUP) +3. Create a new database and a database user for Roundcube (see DATABASE SETUP) 4. Point your browser to http://url-to-roundcube/installer/ 5. Follow the instructions of the install script (or see MANUAL CONFIGURATION) 6. After creating and testing the configuration, remove the installer directory @@ -52,15 +56,22 @@ INSTALLATION CONFIGURATION HINTS =================== -RoundCube writes internal errors to the 'errors' log file located in the logs +Roundcube writes internal errors to the 'errors' log file located in the logs directory which can be configured in config/main.inc.php. If you want ordinary PHP errors to be logged there as well, enable the 'php_value error_log' line in the .htaccess file and set the path to the log file accordingly. +By default the session_path settings of PHP are not modified by Roundcube. +However if you want to limit the session cookies to the directory where +Roundcube resides you can uncomment and configure the according line +in the .htaccess file. + DATABASE SETUP ============== +Note: Database for Roundcube must use UTF-8 character set. + * MySQL ------- Setting up the mysql database can be done by creating an empty database, @@ -79,9 +90,6 @@ Note 1: 'password' is the master password for the roundcube user. It is strongly recommended you replace this with a more secure password. Please keep in mind: You need to specify this password later in 'config/db.inc.php'. -Note 2: For MySQL version 4.1 and up, it's recommended to create the database for -RoundCube with utf-8 charset. - * SQLite -------- @@ -102,7 +110,7 @@ webserver can write to the file and the directory containing the file. * PostgreSQL ------------ -To use RoundCube with PostgreSQL support you have to follow these +To use Roundcube with PostgreSQL support you have to follow these simple steps, which have to be done as the postgres system user (or which ever is the database superuser): @@ -119,6 +127,14 @@ versions don't have a -O option for the createdb, so if you are using that version you'll have to change ownership of the DB later. +Database cleaning +----------------- +Do keep your database slick and clean we recommend to periodically execute +bin/cleandb.sh which finally removes all records that are marked as deleted. +Best solution is to install a cronjob running this script daily. + + + MANUAL CONFIGURATION ==================== @@ -135,7 +151,7 @@ increase the allowed size of file attachments, for example: UPGRADING ========= -If you already have a previous version of RoundCube installed, +If you already have a previous version of Roundcube installed, please refer to the instructions in UPGRADING guide. @@ -143,9 +159,9 @@ OPTIMISING ========== There are two forms of optimisation here, compression and caching, both aimed -at increasing an end user's experience using RoundCube Webmail. Compression +at increasing an end user's experience using Roundcube Webmail. Compression allows the static web pages to be delivered with less bandwidth. The index.php -of RoundCube Webmail already enables compression on its output. The settings +of Roundcube Webmail already enables compression on its output. The settings below allow compression to occur for all static files. Caching sets HTTP response headers that enable a user's web client to understand what is static and how to cache it.