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