Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 236 lines (178 sloc) 8.546 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
e7d9979 @alecpl Update Net_SMTP/Auth_SASL packages to fix Digest-MD5/Cram-MD5 authent…
alecpl authored
24 - Auth_SASL 1.0.6 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
7a259c6 @alecpl Fix magic_quotes_sybase handling (#1488506)
alecpl authored
34 - magic_quotes_sybase disabled
3a01c39 @alecpl - small doc fixed (#1485133)
alecpl authored
35 * 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
36 * A MySQL (4.0.8 or newer), PostgreSQL, MSSQL database engine
37 or the SQLite extension for PHP
1fb2c8e @thomascube Cast to array because this could be empty; update requirements descri…
thomascube authored
38 * One of the above databases with permission to create tables
7d34064 @alecpl - small update
alecpl authored
39 * An SMTP server (recommended) or PHP configured for mail delivery
535da27 @thomascube Updated installation instructions
thomascube authored
40
41
4e17e6c @thomascube Initial revision
thomascube authored
42 INSTALLATION
43 ============
44
45 1. Decompress and put this folder somewhere inside your document root
10a6997 @thomascube Added localized messages to client and check form input
thomascube authored
46 2. Make sure that the following directories (and the files within)
47 are writable by the webserver
4e17e6c @thomascube Initial revision
thomascube authored
48 - /temp
49 - /logs
e019f2d @alecpl - s/RoundCube/Roundcube/
alecpl authored
50 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
51 4. Point your browser to http://url-to-roundcube/installer/
b8ae99a @alecpl - Fix endless loop on error response for APPEND command (#1486060)
alecpl authored
52 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
53 6. After creating and testing the configuration, remove the installer directory
42b1135 @thomascube Several bugfixes and feature improvements
thomascube authored
54 7. Done!
55
56
4b20e28 @thomascube Don't set php_value error_log in .htaccess by default
thomascube authored
57 CONFIGURATION HINTS
58 ===================
59
2336223 @thomascube Replace ALTER TABLE statement in Sqlite schema update script; more pr…
thomascube authored
60 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
61 directory which can be configured in config/main.inc.php. If you want ordinary
62 PHP errors to be logged there as well, enable the 'php_value error_log' line
63 in the .htaccess file and set the path to the log file accordingly.
64
29640bc @thomascube Add (inactive) session.cookie_path line to .htaccess as suggested in …
thomascube authored
65 By default the session_path settings of PHP are not modified by Roundcube.
66 However if you want to limit the session cookies to the directory where
67 Roundcube resides you can uncomment and configure the according line
68 in the .htaccess file.
69
4b20e28 @thomascube Don't set php_value error_log in .htaccess by default
thomascube authored
70
10a6997 @thomascube Added localized messages to client and check form input
thomascube authored
71 DATABASE SETUP
72 ==============
73
2336223 @thomascube Replace ALTER TABLE statement in Sqlite schema update script; more pr…
thomascube authored
74 Note: Database for Roundcube must use UTF-8 character set.
0ba548a @alecpl - add precise note about UTF-8 in database
alecpl authored
75
fa898a4 @thomascube Simplify MYSQL database initialization instructions
thomascube authored
76 * MySQL
77 -------
10a6997 @thomascube Added localized messages to client and check form input
thomascube authored
78 Setting up the mysql database can be done by creating an empty database,
79 importing the table layout and granting the proper permissions to the
80 roundcube user. Here is an example of that procedure:
81
82 # mysql
ad56004 @alecpl - added info to create unicode database (#1485687)
alecpl authored
83 > CREATE DATABASE roundcubemail /*!40101 CHARACTER SET utf8 COLLATE utf8_general_ci */;
10a6997 @thomascube Added localized messages to client and check form input
thomascube authored
84 > GRANT ALL PRIVILEGES ON roundcubemail.* TO roundcube@localhost
6ae6e41 @thomascube Updated description files and version info
thomascube authored
85 IDENTIFIED BY 'password';
10a6997 @thomascube Added localized messages to client and check form input
thomascube authored
86 > quit
aade7b9 @thomascube Finalized 0.1beta2 release
thomascube authored
87
fa898a4 @thomascube Simplify MYSQL database initialization instructions
thomascube authored
88 # mysql roundcubemail < SQL/mysql.initial.sql
535da27 @thomascube Updated installation instructions
thomascube authored
89
fa898a4 @thomascube Simplify MYSQL database initialization instructions
thomascube authored
90 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
91 recommended you replace this with a more secure password. Please keep in
92 mind: You need to specify this password later in 'config/db.inc.php'.
93
1cded85 @thomascube Re-design of caching (new database table added\!); some bugfixes; Pos…
thomascube authored
94
10a6997 @thomascube Added localized messages to client and check form input
thomascube authored
95 * SQLite
96 --------
50d515a @alecpl - some hints to use sqlite db (#1485821)
alecpl authored
97 You need sqlite 2 (preferably 2.8) to setup the sqlite db
98 (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
99 an example how you can setup the sqlite.db for roundcube:
100
101 # sqlite -init SQL/sqlite.initial.sql sqlite.db
d7f49d6 @thomascube Speedup UI by using CSS sprites and etags/expires/deflate for static …
thomascube authored
102 Loading resources from SQL/sqlite.initial.sql
103 SQLite version 2.8.16
104 Enter ".help" for instructions
105 sqlite> .exit
106 # chmod o+rw sqlite.db
10a6997 @thomascube Added localized messages to client and check form input
thomascube authored
107
108 Make sure your configuration points to the sqlite.db file and that the
83ce4bb @thomascube Correct/clarify installation hints
thomascube authored
109 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
110
111
1cded85 @thomascube Re-design of caching (new database table added\!); some bugfixes; Pos…
thomascube authored
112 * PostgreSQL
113 ------------
2336223 @thomascube Replace ALTER TABLE statement in Sqlite schema update script; more pr…
thomascube authored
114 To use Roundcube with PostgreSQL support you have to follow these
a898459 @thomascube Fix wrong Postgres setup instructions in INSTALL
thomascube authored
115 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
116 which ever is the database superuser):
117
a898459 @thomascube Fix wrong Postgres setup instructions in INSTALL
thomascube authored
118 $ createuser roundcube
ad56004 @alecpl - added info to create unicode database (#1485687)
alecpl authored
119 $ createdb -O roundcube -E UNICODE roundcubemail
1cded85 @thomascube Re-design of caching (new database table added\!); some bugfixes; Pos…
thomascube authored
120 $ psql roundcubemail
121
122 roundcubemail =# ALTER USER roundcube WITH PASSWORD 'the_new_password';
a898459 @thomascube Fix wrong Postgres setup instructions in INSTALL
thomascube authored
123 roundcubemail =# \c - roundcube
1cded85 @thomascube Re-design of caching (new database table added\!); some bugfixes; Pos…
thomascube authored
124 roundcubemail => \i SQL/postgres.initial.sql
125
a898459 @thomascube Fix wrong Postgres setup instructions in INSTALL
thomascube authored
126 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
127 versions don't have a -O option for the createdb, so if you are
128 using that version you'll have to change ownership of the DB later.
129
130
2336223 @thomascube Replace ALTER TABLE statement in Sqlite schema update script; more pr…
thomascube authored
131 Database cleaning
132 -----------------
133 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
134 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
135 Best solution is to install a cronjob running this script daily.
136
137
138
190e97e @thomascube Fix database initialization and check write access on the DB; update …
thomascube authored
139 MANUAL CONFIGURATION
140 ====================
535da27 @thomascube Updated installation instructions
thomascube authored
141
a898459 @thomascube Fix wrong Postgres setup instructions in INSTALL
thomascube authored
142 First of all, rename the files config/*.inc.php.dist to config/*.inc.php.
143 You can then change these files according to your environment and your needs.
144 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
145 See http://trac.roundcube.net/wiki/Howto_Install for even more guidance.
535da27 @thomascube Updated installation instructions
thomascube authored
146
4b9efbb Fixes interface lock-up issues and minor bugs (richs)
svncommit authored
147 You can also modify the default .htaccess file. This is necessary to
148 increase the allowed size of file attachments, for example:
149 php_value upload_max_filesize 2M
535da27 @thomascube Updated installation instructions
thomascube authored
150
83ce4bb @thomascube Correct/clarify installation hints
thomascube authored
151
42b1135 @thomascube Several bugfixes and feature improvements
thomascube authored
152 UPGRADING
153 =========
6ae6e41 @thomascube Updated description files and version info
thomascube authored
154
2336223 @thomascube Replace ALTER TABLE statement in Sqlite schema update script; more pr…
thomascube authored
155 If you already have a previous version of Roundcube installed,
42b1135 @thomascube Several bugfixes and feature improvements
thomascube authored
156 please refer to the instructions in UPGRADING guide.
4e17e6c @thomascube Initial revision
thomascube authored
157
158
d7f49d6 @thomascube Speedup UI by using CSS sprites and etags/expires/deflate for static …
thomascube authored
159 OPTIMISING
160 ==========
161
162 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
163 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
164 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
165 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
166 below allow compression to occur for all static files. Caching sets HTTP
167 response headers that enable a user's web client to understand what is static
168 and how to cache it.
169
170 The caching directives used are:
171 * Etags - sets at tag so the client can request is the page has changed
172 * Cache-control - defines the age of the page and that the page is 'public'
173 This enables clients to cache javascript files that don't have private
174 information between sessions even if using HTTPS. It also allows proxies
175 to share the same cached page between users.
176 * Expires - provides another hint to increase the lifetime of static pages.
177
178 For more information refer to RFC 2616.
179
180 Side effects:
181 -------------
182 These directives are designed for production use. If you are using this in
183 a development environment you may get horribly confused if your webclient
184 is caching stuff that you changed on the server. Disabling the expires
185 parts below should save you some grief.
186
187 If you are changing the skins, it is recommended that you copy content to
188 a different directory apart from 'default'.
189
190 Apache:
191 -------
192 To enable these features in apache the following modules need to be enabled:
a5c2ad2 @alecpl - corrected apache modules names
alecpl authored
193 * mod_deflate
194 * mod_expires
d7f49d6 @thomascube Speedup UI by using CSS sprites and etags/expires/deflate for static …
thomascube authored
195 * mod_headers
196
197 The optimisation is already included in the .htaccess file in the top
198 directory of your installation.
199
200 If you are using Apache version 2.2.9 and later, in the .htaccess file
201 change the 'append' word to 'merge' for a more correct response. Keeping
202 as 'append' shouldn't cause any problems though changing to merge will
203 eliminate the possibility of duplicate 'public' headers in Cache-control.
204
205 Lighttpd:
206 ---------
207 With Lightty the addition of Expire: tags by mod_expire is incompatible with
208 the addition of "Cache-control: public". Using Cache-control 'public' is
209 used below as it is assumed to give a better caching result.
210
211 Enable modules in server.modules:
212 "mod_setenv"
213 "mod_compress"
214
215 Mod_compress is a server side cache of compressed files to improve its performance.
216
217 $HTTP["host"] == "www.example.com" {
218
219 static-file.etags = "enable"
220 # http://redmine.lighttpd.net/projects/lighttpd/wiki/Etag.use-mtimeDetails
221 etag.use-mtime = "enable"
222
223 # http://redmine.lighttpd.net/projects/lighttpd/wiki/Docs:ModSetEnv
224 $HTTP["url"] =~ "^/roundcubemail/(plugins|skins|program)" {
225 setenv.add-response-header = ( "Cache-Control" => "public, max-age=2592000")
226 }
227
228 # http://redmine.lighttpd.net/projects/lighttpd/wiki/Docs:ModCompress
229 # set compress.cache-dir to somewhere outside the docroot.
230 compress.cache-dir = var.statedir + "/cache/compress"
231
232 compress.filetype = ("text/plain", "text/html", "text/javascript", "text/css", "text/xml", "image/gif", "image/png")
233 }
234
235
Something went wrong with that request. Please try again.