INSTALL

   1 INTRODUCTION
   2 ============
   3
   4 This file describes the basic steps to install Roundcube Webmail on your
   5 web server. For additional information, please also consult the project's
   6 wiki page at http://trac.roundcube.net/wiki
   7
   8
   9 REQUIREMENTS
  10 ============
  11
  12 * The Apache or Lighttpd Webserver
  13 * .htaccess support allowing overrides for DirectoryIndex
  14 * PHP Version 5.2.1 or greater including
  15    - PCRE, DOM, JSON, XML, Session, Sockets (required)
  16    - Libiconv
  17    - Multibyte String (mbstring)
  18    - Mcrypt (supporting Triple DES)
  19    - Fileinfo (optional)
  20    - Database driver for either MySQL, Postgres or SQLite
  21 * The PEAR framework with the following packages installed:
  22    - MDB2 2.5.0 or newer
  23    - Mail_Mime 1.8.1 or newer
  24    - Net_SMTP 1.4.2 or newer
  25    - Auth_SASL 1.0.3 or newer
  26 * php.ini options (see .htaccess file):
  27    - error_reporting E_ALL & ~E_NOTICE (or lower)
  28    - memory_limit > 16MB (increase as suitable to support large attachments)
  29    - file_uploads enabled (for attachment upload features)
  30    - session.auto_start disabled
  31    - zend.ze1_compatibility_mode disabled
  32    - suhosin.session.encrypt disabled
  33    - mbstring.func_overload disabled
  34 * PHP compiled with OpenSSL to connect to IMAPS and to use the spell checker
  35 * A MySQL (4.0.8 or newer), PostgreSQL, MSSQL database engine
  36   or the SQLite extension for PHP
  37 * One of the above databases with permission to create tables
  38 * An SMTP server (recommended) or PHP configured for mail delivery
  39
  40
  41 INSTALLATION
  42 ============
  43
  44 1. Decompress and put this folder somewhere inside your document root
  45 2. Make sure that the following directories (and the files within)
  46    are writable by the webserver
  47    - /temp
  48    - /logs
  49 3. Create a new database and a database user for Roundcube (see DATABASE SETUP)
  50 4. Point your browser to http://url-to-roundcube/installer/
  51 5. Follow the instructions of the install script (or see MANUAL CONFIGURATION)
  52 6. After creating and testing the configuration, remove the installer directory
  53 7. Done!
  54
  55
  56 CONFIGURATION HINTS
  57 ===================
  58
  59 Roundcube writes internal errors to the 'errors' log file located in the logs
  60 directory which can be configured in config/main.inc.php. If you want ordinary
  61 PHP errors to be logged there as well, enable the 'php_value error_log' line
  62 in the .htaccess file and set the path to the log file accordingly.
  63
  64 By default the session_path settings of PHP are not modified by Roundcube.
  65 However if you want to limit the session cookies to the directory where
  66 Roundcube resides you can uncomment and configure the according line
  67 in the .htaccess file.
  68
  69
  70 DATABASE SETUP
  71 ==============
  72
  73 Note: Database for Roundcube must use UTF-8 character set.
  74
  75 * MySQL
  76 -------
  77 Setting up the mysql database can be done by creating an empty database,
  78 importing the table layout and granting the proper permissions to the
  79 roundcube user. Here is an example of that procedure:
  80
  81 # mysql
  82 > CREATE DATABASE roundcubemail /*!40101 CHARACTER SET utf8 COLLATE utf8_general_ci */;
  83 > GRANT ALL PRIVILEGES ON roundcubemail.* TO roundcube@localhost
  84     IDENTIFIED BY 'password';
  85 > quit
  86
  87 # mysql roundcubemail < SQL/mysql.initial.sql
  88
  89 Note 1: 'password' is the master password for the roundcube user. It is strongly
  90 recommended you replace this with a more secure password. Please keep in
  91 mind: You need to specify this password later in 'config/db.inc.php'.
  92
  93
  94 * SQLite
  95 --------
  96 You need sqlite 2 (preferably 2.8) to setup the sqlite db
  97 (sqlite 3.x also doesn't work at the moment). Here is
  98 an example how you can setup the sqlite.db for roundcube:
  99
 100 # sqlite -init SQL/sqlite.initial.sql sqlite.db
 101 Loading resources from SQL/sqlite.initial.sql
 102 SQLite version 2.8.16
 103 Enter ".help" for instructions
 104 sqlite> .exit
 105 # chmod o+rw sqlite.db
 106
 107 Make sure your configuration points to the sqlite.db file and that the
 108 webserver can write to the file and the directory containing the file.
 109
 110
 111 * PostgreSQL
 112 ------------
 113 To use Roundcube with PostgreSQL support you have to follow these
 114 simple steps, which have to be done as the postgres system user (or
 115 which ever is the database superuser):
 116
 117 $ createuser roundcube
 118 $ createdb -O roundcube -E UNICODE roundcubemail
 119 $ psql roundcubemail
 120
 121 roundcubemail =# ALTER USER roundcube WITH PASSWORD 'the_new_password';
 122 roundcubemail =# \c - roundcube
 123 roundcubemail => \i SQL/postgres.initial.sql
 124
 125 All this has been tested with PostgreSQL 8.x and 7.4.x. Older
 126 versions don't have a -O option for the createdb, so if you are
 127 using that version you'll have to change ownership of the DB later.
 128
 129
 130 Database cleaning
 131 -----------------
 132 Do keep your database slick and clean we recommend to periodically execute
 133 bin/cleandb.sh which finally removes all records that are marked as deleted.
 134 Best solution is to install a cronjob running this script daily.
 135
 136
 137
 138 MANUAL CONFIGURATION
 139 ====================
 140
 141 First of all, rename the files config/*.inc.php.dist to config/*.inc.php.
 142 You can then change these files according to your environment and your needs.
 143 Details about the config parameters can be found in the config files.
 144 See http://trac.roundcube.net/wiki/Howto_Install for even more guidance.
 145
 146 You can also modify the default .htaccess file. This is necessary to
 147 increase the allowed size of file attachments, for example:
 148         php_value       upload_max_filesize     2M
 149
 150
 151 UPGRADING
 152 =========
 153
 154 If you already have a previous version of Roundcube installed,
 155 please refer to the instructions in UPGRADING guide.
 156
 157
 158 OPTIMISING
 159 ==========
 160
 161 There are two forms of optimisation here, compression and caching, both aimed
 162 at increasing an end user's experience using Roundcube Webmail. Compression
 163 allows the static web pages to be delivered with less bandwidth. The index.php
 164 of Roundcube Webmail already enables compression on its output. The settings
 165 below allow compression to occur for all static files. Caching sets HTTP
 166 response headers that enable a user's web client to understand what is static
 167 and how to cache it.
 168
 169 The caching directives used are:
 170  * Etags - sets at tag so the client can request is the page has changed
 171  * Cache-control - defines the age of the page and that the page is 'public'
 172    This enables clients to cache javascript files that don't have private
 173    information between sessions even if using HTTPS. It also allows proxies
 174    to share the same cached page between users.
 175  * Expires - provides another hint to increase the lifetime of static pages.
 176
 177 For more information refer to RFC 2616.
 178
 179 Side effects:
 180 -------------
 181 These directives are designed for production use. If you are using this in
 182 a development environment you may get horribly confused if your webclient
 183 is caching stuff that you changed on the server. Disabling the expires
 184 parts below should save you some grief.
 185
 186 If you are changing the skins, it is recommended that you copy content to
 187 a different directory apart from 'default'.
 188
 189 Apache:
 190 -------
 191 To enable these features in apache the following modules need to be enabled:
 192  * mod_deflate
 193  * mod_expires
 194  * mod_headers
 195
 196 The optimisation is already included in the .htaccess file in the top
 197 directory of your installation.
 198
 199 If you are using Apache version 2.2.9 and later, in the .htaccess file
 200 change the 'append' word to 'merge' for a more correct response. Keeping
 201 as 'append' shouldn't cause any problems though changing to merge will
 202 eliminate the possibility of duplicate 'public' headers in Cache-control.
 203
 204 Lighttpd:
 205 ---------
 206 With Lightty the addition of Expire: tags by mod_expire is incompatible with
 207 the addition of "Cache-control: public". Using Cache-control 'public' is
 208 used below as it is assumed to give a better caching result.
 209
 210 Enable modules in server.modules:
 211     "mod_setenv"
 212     "mod_compress"
 213
 214 Mod_compress is a server side cache of compressed files to improve its performance.
 215
 216 $HTTP["host"] == "www.example.com" {
 217
 218     static-file.etags = "enable"
 219     # http://redmine.lighttpd.net/projects/lighttpd/wiki/Etag.use-mtimeDetails
 220     etag.use-mtime = "enable"
 221
 222     # http://redmine.lighttpd.net/projects/lighttpd/wiki/Docs:ModSetEnv
 223     $HTTP["url"] =~ "^/roundcubemail/(plugins|skins|program)" {
 224         setenv.add-response-header  = ( "Cache-Control" => "public, max-age=2592000")
 225     }
 226
 227     # http://redmine.lighttpd.net/projects/lighttpd/wiki/Docs:ModCompress
 228     # set compress.cache-dir to somewhere outside the docroot.
 229     compress.cache-dir   = var.statedir + "/cache/compress"
 230
 231     compress.filetype = ("text/plain", "text/html", "text/javascript", "text/css", "text/xml", "image/gif", "image/png")
 232 }
 233
 234