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