Pascal Herbert
2014-09-28 de6bf0703034a7ad60191ab3d35b8dab615f4d02
commit | author | age
a89845 1 INTRODUCTION
T 2 ============
3
e019f2 4 This file describes the basic steps to install Roundcube Webmail on your
a89845 5 web server. For additional information, please also consult the project's
83ce4b 6 wiki page at http://trac.roundcube.net/wiki
T 7
4e17e6 8
535da2 9 REQUIREMENTS
T 10 ============
11
5d62d9 12 * The Apache, Lighttpd, Cherokee or Hiawatha web server
535da2 13 * .htaccess support allowing overrides for DirectoryIndex
8cc567 14 * PHP Version 5.3.7 or greater including
a84efc 15    - PCRE, DOM, JSON, XML, Session, Sockets (required)
TB 16    - PHP Data Objects (PDO) with driver for either MySQL, PostgreSQL or SQLite (required)
17    - Libiconv, Zip (recommended)
6c1c60 18    - OpenSSL, Fileinfo, Mcrypt, mbstring (optional)
91790e 19 * PEAR packages distributed with Roundcube or external:
53604a 20    - Mail_Mime 1.8.1 or newer
77c779 21    - Mail_mimeDecode 1.5.5 or newer
c4a226 22    - Net_SMTP (latest from https://github.com/pear/Net_SMTP/)
50d7d3 23    - Net_IDNA2 0.1.1 or newer
114cf1 24    - Auth_SASL 1.0.6 or newer
52674e 25    - Net_Sieve 1.3.2 or newer (for managesieve plugin)
4daaa0 26    - Crypt_GPG 1.2.0 or newer (for enigma plugin)
7d3406 27 * php.ini options (see .htaccess file):
535da2 28    - error_reporting E_ALL & ~E_NOTICE (or lower)
29640b 29    - memory_limit > 16MB (increase as suitable to support large attachments)
067763 30    - file_uploads enabled (for attachment upload features)
A 31    - session.auto_start disabled
32    - zend.ze1_compatibility_mode disabled
7d3406 33    - suhosin.session.encrypt disabled
A 34    - mbstring.func_overload disabled
140abb 35    - magic_quotes_runtime disabled
0b6d02 36    - magic_quotes_sybase disabled
0314bf 37    - register_globals disabled (PHP < 5.4)
6c1c60 38 * PHP compiled with OpenSSL to use secure (tls/ssl) connections and to use the spell checker
ec6a77 39 * A MySQL (4.0.8 or newer), PostgreSQL, MS SQL Server (2005 or newer) database engine
d239ee 40   or SQLite support in PHP
1fb2c8 41 * One of the above databases with permission to create tables
7d3406 42 * An SMTP server (recommended) or PHP configured for mail delivery
1985eb 43 * Composer installed either locally or globally
535da2 44
T 45
4e17e6 46 INSTALLATION
T 47 ============
48
49 1. Decompress and put this folder somewhere inside your document root
1985eb 50 2. Install dependencies using composer:
TB 51    - get composer from https://getcomposer.org/download/
52    - rename the composer.json-dist file into composer.json
53    - run `php composer.phar install`
54 3. Make sure that the following directories (and the files within)
10a699 55    are writable by the webserver
4e17e6 56    - /temp
T 57    - /logs
1985eb 58 4. Create a new database and a database user for Roundcube (see DATABASE SETUP)
TB 59 5. Point your browser to http://url-to-roundcube/installer/
60 6. Follow the instructions of the install script (or see MANUAL CONFIGURATION)
61 7. After creating and testing the configuration, remove the installer directory
62 8. Check Known Issues section of this file
42b113 63
T 64
4b20e2 65 CONFIGURATION HINTS
T 66 ===================
67
233622 68 Roundcube writes internal errors to the 'errors' log file located in the logs
461a30 69 directory which can be configured in config/config.inc.php. If you want ordinary
4b20e2 70 PHP errors to be logged there as well, enable the 'php_value error_log' line
T 71 in the .htaccess file and set the path to the log file accordingly.
72
29640b 73 By default the session_path settings of PHP are not modified by Roundcube.
T 74 However if you want to limit the session cookies to the directory where
75 Roundcube resides you can uncomment and configure the according line
76 in the .htaccess file.
77
4b20e2 78
10a699 79 DATABASE SETUP
T 80 ==============
81
233622 82 Note: Database for Roundcube must use UTF-8 character set.
0ba548 83
fa898a 84 * MySQL
T 85 -------
10a699 86 Setting up the mysql database can be done by creating an empty database,
T 87 importing the table layout and granting the proper permissions to the
88 roundcube user. Here is an example of that procedure:
89
90 # mysql
ad5600 91 > CREATE DATABASE roundcubemail /*!40101 CHARACTER SET utf8 COLLATE utf8_general_ci */;
10a699 92 > GRANT ALL PRIVILEGES ON roundcubemail.* TO roundcube@localhost
6ae6e4 93     IDENTIFIED BY 'password';
10a699 94 > quit
fa898a 95
10a699 96 # mysql roundcubemail < SQL/mysql.initial.sql
535da2 97
fa898a 98 Note 1: 'password' is the master password for the roundcube user. It is strongly
3cf664 99 recommended you replace this with a more secure password. Please keep in
T 100 mind: You need to specify this password later in 'config/db.inc.php'.
fa898a 101
1cded8 102
10a699 103 * SQLite
T 104 --------
8da072 105 Versions of sqlite database engine older than 3 aren't supported.
AM 106 Database file and structure is created automatically by Roundcube.
107 Make sure your configuration points to some file location and that the
83ce4b 108 webserver can write to the file and the directory containing the file.
10a699 109
T 110
1cded8 111 * PostgreSQL
T 112 ------------
233622 113 To use Roundcube with PostgreSQL support you have to follow these
a89845 114 simple steps, which have to be done as the postgres system user (or
1cded8 115 which ever is the database superuser):
T 116
b91bc1 117 $ createuser -P roundcube
ad5600 118 $ createdb -O roundcube -E UNICODE roundcubemail
b91bc1 119 $ psql -U roundcube -f SQL/postgres.initial.sql roundcubemail
1cded8 120
b91bc1 121 Note: in some system configurations you might need to add '-U postgres' to
AM 122 createuser and createdb commands.
233622 123
T 124
c72f69 125 * Microsoft SQL Server
AM 126 ----------------------
127 Language/locale of the database must be set to us_english (1033). More info
128 on this at http://trac.roundcube.net/ticket/1488918.
129
130
233622 131 Database cleaning
T 132 -----------------
c72f69 133 To keep your database slick and clean we recommend to periodically execute
30aa4c 134 bin/cleandb.sh which finally removes all records that are marked as deleted.
233622 135 Best solution is to install a cronjob running this script daily.
1cded8 136
T 137
190e97 138 MANUAL CONFIGURATION
T 139 ====================
535da2 140
9bacb2 141 First of all, copy the sample configuration file config/config.inc.php.sample
TB 142 to config/config.inc.php and make the necessary adjustments according to your
143 environment and your needs. More configuration options can be copied from the
144 config/defaults.inc.php file into your local config.inc.php file as needed.
145 Read the comments above the individual configuration options to find out what
146 they do or read http://trac.roundcube.net/wiki/Howto_Install for even more
147 guidance.
535da2 148
4b9efb 149 You can also modify the default .htaccess file. This is necessary to
S 150 increase the allowed size of file attachments, for example:
151     php_value       upload_max_filesize     2M
535da2 152
83ce4b 153
42b113 154 UPGRADING
T 155 =========
6ae6e4 156
233622 157 If you already have a previous version of Roundcube installed,
42b113 158 please refer to the instructions in UPGRADING guide.
4e17e6 159
T 160
d7f49d 161 OPTIMISING
T 162 ==========
163
164 There are two forms of optimisation here, compression and caching, both aimed
233622 165 at increasing an end user's experience using Roundcube Webmail. Compression
d7f49d 166 allows the static web pages to be delivered with less bandwidth. The index.php
233622 167 of Roundcube Webmail already enables compression on its output. The settings
d7f49d 168 below allow compression to occur for all static files. Caching sets HTTP 
T 169 response headers that enable a user's web client to understand what is static
170 and how to cache it.
171
172 The caching directives used are:
173  * Etags - sets at tag so the client can request is the page has changed
174  * Cache-control - defines the age of the page and that the page is 'public'
175    This enables clients to cache javascript files that don't have private 
176    information between sessions even if using HTTPS. It also allows proxies
177    to share the same cached page between users.
178  * Expires - provides another hint to increase the lifetime of static pages.
179
180 For more information refer to RFC 2616.
181
182 Side effects:
183 -------------
184 These directives are designed for production use. If you are using this in
185 a development environment you may get horribly confused if your webclient
186 is caching stuff that you changed on the server. Disabling the expires 
187 parts below should save you some grief.
188
189 If you are changing the skins, it is recommended that you copy content to 
190 a different directory apart from 'default'.
191
192 Apache:
193 -------
194 To enable these features in apache the following modules need to be enabled:
a5c2ad 195  * mod_deflate
A 196  * mod_expires
d7f49d 197  * mod_headers
T 198
199 The optimisation is already included in the .htaccess file in the top 
200 directory of your installation.
201
202 If you are using Apache version 2.2.9 and later, in the .htaccess file
203 change the 'append' word to 'merge' for a more correct response. Keeping
204 as 'append' shouldn't cause any problems though changing to merge will 
205 eliminate the possibility of duplicate 'public' headers in Cache-control.
206
207 Lighttpd:
208 ---------
209 With Lightty the addition of Expire: tags by mod_expire is incompatible with
210 the addition of "Cache-control: public". Using Cache-control 'public' is 
211 used below as it is assumed to give a better caching result.
212
213 Enable modules in server.modules:
214     "mod_setenv"
215     "mod_compress"
216
217 Mod_compress is a server side cache of compressed files to improve its performance.
218
219 $HTTP["host"] == "www.example.com" {
220
221     static-file.etags = "enable"
222     # http://redmine.lighttpd.net/projects/lighttpd/wiki/Etag.use-mtimeDetails
223     etag.use-mtime = "enable"
224
225     # http://redmine.lighttpd.net/projects/lighttpd/wiki/Docs:ModSetEnv
226     $HTTP["url"] =~ "^/roundcubemail/(plugins|skins|program)" {
227         setenv.add-response-header  = ( "Cache-Control" => "public, max-age=2592000")
228     }
229
230     # http://redmine.lighttpd.net/projects/lighttpd/wiki/Docs:ModCompress
231     # set compress.cache-dir to somewhere outside the docroot.
232     compress.cache-dir   = var.statedir + "/cache/compress"
233
234     compress.filetype = ("text/plain", "text/html", "text/javascript", "text/css", "text/xml", "image/gif", "image/png")
235 }
ed3e51 236
AM 237
238 KNOWN ISSUES
239 ============
240
241 Installations with uw-imap server should set imap_disabled_caps = array('ESEARCH')
242 in main configuration file. ESEARCH implementation in this server is broken (#1489184).