INSTALL.orig

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