Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 235 lines (177 sloc) 8.512 kB
a898459 @thomascube Fix wrong Postgres setup instructions in INSTALL
thomascube authored
1 INTRODUCTION
2 ============
3
e019f2d @alecpl - s/RoundCube/Roundcube/
alecpl authored
4 This file describes the basic steps to install Roundcube Webmail on your
a898459 @thomascube Fix wrong Postgres setup instructions in INSTALL
thomascube authored
5 web server. For additional information, please also consult the project's
83ce4bb @thomascube Correct/clarify installation hints
thomascube authored
6 wiki page at http://trac.roundcube.net/wiki
7
4e17e6c @thomascube Initial revision
thomascube authored
8
535da27 @thomascube Updated installation instructions
thomascube authored
9 REQUIREMENTS
10 ============
11
5d62d9a @thomascube Add Cherokee and Hiawatha webservers to requirements list
thomascube authored
12 * The Apache, Lighttpd, Cherokee or Hiawatha web server
535da27 @thomascube Updated installation instructions
thomascube authored
13 * .htaccess support allowing overrides for DirectoryIndex
d36115b @alecpl - Require PHP 5.2.1 or greater
alecpl authored
14 * PHP Version 5.2.1 or greater including
0f96874 @alecpl - update requirements, remove GD check
alecpl authored
15 - PCRE, DOM, JSON, XML, Session, Sockets (required)
1fb2c8e @thomascube Cast to array because this could be empty; update requirements descri…
thomascube authored
16 - libiconv (recommended)
0f96874 @alecpl - update requirements, remove GD check
alecpl authored
17 - mbstring, fileinfo, mcrypt (optional)
91790e4 @alecpl - Fix attachment excessive memory use, support messages of any size (…
alecpl authored
18 * PEAR packages distributed with Roundcube or external:
19 - MDB2 2.5.0 or newer
53604a0 @alecpl - Fix setting charset of attachment filenames (#1487122)
alecpl authored
20 - Mail_Mime 1.8.1 or newer
77c779a @thomascube Update requirements list, remove TODO
thomascube authored
21 - Mail_mimeDecode 1.5.5 or newer
cc2c833 @alecpl - Net_SMTP 1.4.2 with fix for #1486537
alecpl authored
22 - Net_SMTP 1.4.2 or newer
50d7d32 @thomascube List Net_IDNA2 as required lib
thomascube authored
23 - Net_IDNA2 0.1.1 or newer
5c84da1 @thomascube Mention Auth_SASL as required PEAR package
thomascube authored
24 - Auth_SASL 1.0.3 or newer
7d34064 @alecpl - small update
alecpl authored
25 * php.ini options (see .htaccess file):
535da27 @thomascube Updated installation instructions
thomascube authored
26 - error_reporting E_ALL & ~E_NOTICE (or lower)
29640bc @thomascube Add (inactive) session.cookie_path line to .htaccess as suggested in …
thomascube authored
27 - memory_limit > 16MB (increase as suitable to support large attachments)
0677630 @alecpl - updated php.ini settings requirements
alecpl authored
28 - file_uploads enabled (for attachment upload features)
29 - session.auto_start disabled
30 - zend.ze1_compatibility_mode disabled
7d34064 @alecpl - small update
alecpl authored
31 - suhosin.session.encrypt disabled
32 - mbstring.func_overload disabled
140abb0 @alecpl - Require magic_quotes_runtime=Off because it modifies data streams (…
alecpl authored
33 - magic_quotes_runtime disabled
3a01c39 @alecpl - small doc fixed (#1485133)
alecpl authored
34 * PHP compiled with OpenSSL to connect to IMAPS and to use the spell checker
94fe9ca @alecpl - re-fix (#1486474) + require MySQL 4.0.8 + add index/update in ident…
alecpl authored
35 * A MySQL (4.0.8 or newer), PostgreSQL, MSSQL database engine
36 or the SQLite extension for PHP
1fb2c8e @thomascube Cast to array because this could be empty; update requirements descri…
thomascube authored
37 * One of the above databases with permission to create tables
7d34064 @alecpl - small update
alecpl authored
38 * An SMTP server (recommended) or PHP configured for mail delivery
535da27 @thomascube Updated installation instructions
thomascube authored
39
40
4e17e6c @thomascube Initial revision
thomascube authored
41 INSTALLATION
42 ============
43
44 1. Decompress and put this folder somewhere inside your document root
10a6997 @thomascube Added localized messages to client and check form input
thomascube authored
45 2. Make sure that the following directories (and the files within)
46 are writable by the webserver
4e17e6c @thomascube Initial revision
thomascube authored
47 - /temp
48 - /logs
e019f2d @alecpl - s/RoundCube/Roundcube/
alecpl authored
49 3. Create a new database and a database user for Roundcube (see DATABASE SETUP)
967b342 @thomascube Disable installer by default; add config option to enable it again
thomascube authored
50 4. Point your browser to http://url-to-roundcube/installer/
b8ae99a @alecpl - Fix endless loop on error response for APPEND command (#1486060)
alecpl authored
51 5. Follow the instructions of the install script (or see MANUAL CONFIGURATION)
190e97e @thomascube Fix database initialization and check write access on the DB; update …
thomascube authored
52 6. After creating and testing the configuration, remove the installer directory
42b1135 @thomascube Several bugfixes and feature improvements
thomascube authored
53 7. Done!
54
55
4b20e28 @thomascube Don't set php_value error_log in .htaccess by default
thomascube authored
56 CONFIGURATION HINTS
57 ===================
58
2336223 @thomascube Replace ALTER TABLE statement in Sqlite schema update script; more pr…
thomascube authored
59 Roundcube writes internal errors to the 'errors' log file located in the logs
4b20e28 @thomascube Don't set php_value error_log in .htaccess by default
thomascube authored
60 directory which can be configured in config/main.inc.php. If you want ordinary
61 PHP errors to be logged there as well, enable the 'php_value error_log' line
62 in the .htaccess file and set the path to the log file accordingly.
63
29640bc @thomascube Add (inactive) session.cookie_path line to .htaccess as suggested in …
thomascube authored
64 By default the session_path settings of PHP are not modified by Roundcube.
65 However if you want to limit the session cookies to the directory where
66 Roundcube resides you can uncomment and configure the according line
67 in the .htaccess file.
68
4b20e28 @thomascube Don't set php_value error_log in .htaccess by default
thomascube authored
69
10a6997 @thomascube Added localized messages to client and check form input
thomascube authored
70 DATABASE SETUP
71 ==============
72
2336223 @thomascube Replace ALTER TABLE statement in Sqlite schema update script; more pr…
thomascube authored
73 Note: Database for Roundcube must use UTF-8 character set.
0ba548a @alecpl - add precise note about UTF-8 in database
alecpl authored
74
fa898a4 @thomascube Simplify MYSQL database initialization instructions
thomascube authored
75 * MySQL
76 -------
10a6997 @thomascube Added localized messages to client and check form input
thomascube authored
77 Setting up the mysql database can be done by creating an empty database,
78 importing the table layout and granting the proper permissions to the
79 roundcube user. Here is an example of that procedure:
80
81 # mysql
ad56004 @alecpl - added info to create unicode database (#1485687)
alecpl authored
82 > CREATE DATABASE roundcubemail /*!40101 CHARACTER SET utf8 COLLATE utf8_general_ci */;
10a6997 @thomascube Added localized messages to client and check form input
thomascube authored
83 > GRANT ALL PRIVILEGES ON roundcubemail.* TO roundcube@localhost
6ae6e41 @thomascube Updated description files and version info
thomascube authored
84 IDENTIFIED BY 'password';
10a6997 @thomascube Added localized messages to client and check form input
thomascube authored
85 > quit
aade7b9 @thomascube Finalized 0.1beta2 release
thomascube authored
86
fa898a4 @thomascube Simplify MYSQL database initialization instructions
thomascube authored
87 # mysql roundcubemail < SQL/mysql.initial.sql
535da27 @thomascube Updated installation instructions
thomascube authored
88
fa898a4 @thomascube Simplify MYSQL database initialization instructions
thomascube authored
89 Note 1: 'password' is the master password for the roundcube user. It is strongly
3cf6649 @thomascube Minor bugfixes posted to the dev-mailing list
thomascube authored
90 recommended you replace this with a more secure password. Please keep in
91 mind: You need to specify this password later in 'config/db.inc.php'.
92
1cded85 @thomascube Re-design of caching (new database table added\!); some bugfixes; Pos…
thomascube authored
93
10a6997 @thomascube Added localized messages to client and check form input
thomascube authored
94 * SQLite
95 --------
50d515a @alecpl - some hints to use sqlite db (#1485821)
alecpl authored
96 You need sqlite 2 (preferably 2.8) to setup the sqlite db
97 (sqlite 3.x also doesn't work at the moment). Here is
10a6997 @thomascube Added localized messages to client and check form input
thomascube authored
98 an example how you can setup the sqlite.db for roundcube:
99
100 # sqlite -init SQL/sqlite.initial.sql sqlite.db
d7f49d6 @thomascube Speedup UI by using CSS sprites and etags/expires/deflate for static …
thomascube authored
101 Loading resources from SQL/sqlite.initial.sql
102 SQLite version 2.8.16
103 Enter ".help" for instructions
104 sqlite> .exit
105 # chmod o+rw sqlite.db
10a6997 @thomascube Added localized messages to client and check form input
thomascube authored
106
107 Make sure your configuration points to the sqlite.db file and that the
83ce4bb @thomascube Correct/clarify installation hints
thomascube authored
108 webserver can write to the file and the directory containing the file.
10a6997 @thomascube Added localized messages to client and check form input
thomascube authored
109
110
1cded85 @thomascube Re-design of caching (new database table added\!); some bugfixes; Pos…
thomascube authored
111 * PostgreSQL
112 ------------
2336223 @thomascube Replace ALTER TABLE statement in Sqlite schema update script; more pr…
thomascube authored
113 To use Roundcube with PostgreSQL support you have to follow these
a898459 @thomascube Fix wrong Postgres setup instructions in INSTALL
thomascube authored
114 simple steps, which have to be done as the postgres system user (or
1cded85 @thomascube Re-design of caching (new database table added\!); some bugfixes; Pos…
thomascube authored
115 which ever is the database superuser):
116
a898459 @thomascube Fix wrong Postgres setup instructions in INSTALL
thomascube authored
117 $ createuser roundcube
ad56004 @alecpl - added info to create unicode database (#1485687)
alecpl authored
118 $ createdb -O roundcube -E UNICODE roundcubemail
1cded85 @thomascube Re-design of caching (new database table added\!); some bugfixes; Pos…
thomascube authored
119 $ psql roundcubemail
120
121 roundcubemail =# ALTER USER roundcube WITH PASSWORD 'the_new_password';
a898459 @thomascube Fix wrong Postgres setup instructions in INSTALL
thomascube authored
122 roundcubemail =# \c - roundcube
1cded85 @thomascube Re-design of caching (new database table added\!); some bugfixes; Pos…
thomascube authored
123 roundcubemail => \i SQL/postgres.initial.sql
124
a898459 @thomascube Fix wrong Postgres setup instructions in INSTALL
thomascube authored
125 All this has been tested with PostgreSQL 8.x and 7.4.x. Older
1cded85 @thomascube Re-design of caching (new database table added\!); some bugfixes; Pos…
thomascube authored
126 versions don't have a -O option for the createdb, so if you are
127 using that version you'll have to change ownership of the DB later.
128
129
2336223 @thomascube Replace ALTER TABLE statement in Sqlite schema update script; more pr…
thomascube authored
130 Database cleaning
131 -----------------
132 Do keep your database slick and clean we recommend to periodically execute
30aa4cc @alecpl - Renamed all php-cli scripts to use .sh extension
alecpl authored
133 bin/cleandb.sh which finally removes all records that are marked as deleted.
2336223 @thomascube Replace ALTER TABLE statement in Sqlite schema update script; more pr…
thomascube authored
134 Best solution is to install a cronjob running this script daily.
135
136
137
190e97e @thomascube Fix database initialization and check write access on the DB; update …
thomascube authored
138 MANUAL CONFIGURATION
139 ====================
535da27 @thomascube Updated installation instructions
thomascube authored
140
a898459 @thomascube Fix wrong Postgres setup instructions in INSTALL
thomascube authored
141 First of all, rename the files config/*.inc.php.dist to config/*.inc.php.
142 You can then change these files according to your environment and your needs.
143 Details about the config parameters can be found in the config files.
190e97e @thomascube Fix database initialization and check write access on the DB; update …
thomascube authored
144 See http://trac.roundcube.net/wiki/Howto_Install for even more guidance.
535da27 @thomascube Updated installation instructions
thomascube authored
145
4b9efbb Fixes interface lock-up issues and minor bugs (richs)
svncommit authored
146 You can also modify the default .htaccess file. This is necessary to
147 increase the allowed size of file attachments, for example:
148 php_value upload_max_filesize 2M
535da27 @thomascube Updated installation instructions
thomascube authored
149
83ce4bb @thomascube Correct/clarify installation hints
thomascube authored
150
42b1135 @thomascube Several bugfixes and feature improvements
thomascube authored
151 UPGRADING
152 =========
6ae6e41 @thomascube Updated description files and version info
thomascube authored
153
2336223 @thomascube Replace ALTER TABLE statement in Sqlite schema update script; more pr…
thomascube authored
154 If you already have a previous version of Roundcube installed,
42b1135 @thomascube Several bugfixes and feature improvements
thomascube authored
155 please refer to the instructions in UPGRADING guide.
4e17e6c @thomascube Initial revision
thomascube authored
156
157
d7f49d6 @thomascube Speedup UI by using CSS sprites and etags/expires/deflate for static …
thomascube authored
158 OPTIMISING
159 ==========
160
161 There are two forms of optimisation here, compression and caching, both aimed
2336223 @thomascube Replace ALTER TABLE statement in Sqlite schema update script; more pr…
thomascube authored
162 at increasing an end user's experience using Roundcube Webmail. Compression
d7f49d6 @thomascube Speedup UI by using CSS sprites and etags/expires/deflate for static …
thomascube authored
163 allows the static web pages to be delivered with less bandwidth. The index.php
2336223 @thomascube Replace ALTER TABLE statement in Sqlite schema update script; more pr…
thomascube authored
164 of Roundcube Webmail already enables compression on its output. The settings
d7f49d6 @thomascube Speedup UI by using CSS sprites and etags/expires/deflate for static …
thomascube authored
165 below allow compression to occur for all static files. Caching sets HTTP
166 response headers that enable a user's web client to understand what is static
167 and how to cache it.
168
169 The caching directives used are:
170 * Etags - sets at tag so the client can request is the page has changed
171 * Cache-control - defines the age of the page and that the page is 'public'
172 This enables clients to cache javascript files that don't have private
173 information between sessions even if using HTTPS. It also allows proxies
174 to share the same cached page between users.
175 * Expires - provides another hint to increase the lifetime of static pages.
176
177 For more information refer to RFC 2616.
178
179 Side effects:
180 -------------
181 These directives are designed for production use. If you are using this in
182 a development environment you may get horribly confused if your webclient
183 is caching stuff that you changed on the server. Disabling the expires
184 parts below should save you some grief.
185
186 If you are changing the skins, it is recommended that you copy content to
187 a different directory apart from 'default'.
188
189 Apache:
190 -------
191 To enable these features in apache the following modules need to be enabled:
a5c2ad2 @alecpl - corrected apache modules names
alecpl authored
192 * mod_deflate
193 * mod_expires
d7f49d6 @thomascube Speedup UI by using CSS sprites and etags/expires/deflate for static …
thomascube authored
194 * mod_headers
195
196 The optimisation is already included in the .htaccess file in the top
197 directory of your installation.
198
199 If you are using Apache version 2.2.9 and later, in the .htaccess file
200 change the 'append' word to 'merge' for a more correct response. Keeping
201 as 'append' shouldn't cause any problems though changing to merge will
202 eliminate the possibility of duplicate 'public' headers in Cache-control.
203
204 Lighttpd:
205 ---------
206 With Lightty the addition of Expire: tags by mod_expire is incompatible with
207 the addition of "Cache-control: public". Using Cache-control 'public' is
208 used below as it is assumed to give a better caching result.
209
210 Enable modules in server.modules:
211 "mod_setenv"
212 "mod_compress"
213
214 Mod_compress is a server side cache of compressed files to improve its performance.
215
216 $HTTP["host"] == "www.example.com" {
217
218 static-file.etags = "enable"
219 # http://redmine.lighttpd.net/projects/lighttpd/wiki/Etag.use-mtimeDetails
220 etag.use-mtime = "enable"
221
222 # http://redmine.lighttpd.net/projects/lighttpd/wiki/Docs:ModSetEnv
223 $HTTP["url"] =~ "^/roundcubemail/(plugins|skins|program)" {
224 setenv.add-response-header = ( "Cache-Control" => "public, max-age=2592000")
225 }
226
227 # http://redmine.lighttpd.net/projects/lighttpd/wiki/Docs:ModCompress
228 # set compress.cache-dir to somewhere outside the docroot.
229 compress.cache-dir = var.statedir + "/cache/compress"
230
231 compress.filetype = ("text/plain", "text/html", "text/javascript", "text/css", "text/xml", "image/gif", "image/png")
232 }
233
234
Something went wrong with that request. Please try again.