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