Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 232 lines (177 sloc) 8.557 kb
a898459b » thomascube
2007-11-25 Fix wrong Postgres setup instructions in INSTALL
1 INTRODUCTION
2 ============
3
e019f2d0 » alecpl
2010-09-25 - s/RoundCube/Roundcube/
4 This file describes the basic steps to install Roundcube Webmail on your
a898459b » thomascube
2007-11-25 Fix wrong Postgres setup instructions in INSTALL
5 web server. For additional information, please also consult the project's
83ce4bb0 » thomascube
2008-02-18 Correct/clarify installation hints
6 wiki page at http://trac.roundcube.net/wiki
7
4e17e6c9 » thomascube
2005-09-25 Initial revision
8
535da27c » thomascube
2006-02-19 Updated installation instructions
9 REQUIREMENTS
10 ============
11
5d62d9af » thomascube
2011-09-19 Add Cherokee and Hiawatha webservers to requirements list
12 * The Apache, Lighttpd, Cherokee or Hiawatha web server
535da27c » thomascube
2006-02-19 Updated installation instructions
13 * .htaccess support allowing overrides for DirectoryIndex
d36115bf » alecpl
2011-01-14 - Require PHP 5.2.1 or greater
14 * PHP Version 5.2.1 or greater including
d239ee6d » alecpl
2012-07-06 Add PDO to requirements, remove MDB2 package
15 - PDO, PCRE, DOM, JSON, XML, Session, Sockets (required)
371a09b0 » thomascube
2012-09-24 Update changelog; mention zipdownload requirements in install notes
16 - libiconv, zip (recommended)
0f968743 » alecpl
2010-02-03 - update requirements, remove GD check
17 - mbstring, fileinfo, mcrypt (optional)
91790e41 » alecpl
2010-02-09 - Fix attachment excessive memory use, support messages of any size (…
18 * PEAR packages distributed with Roundcube or external:
53604a05 » alecpl
2010-12-01 - Fix setting charset of attachment filenames (#1487122)
19 - Mail_Mime 1.8.1 or newer
77c779a2 » thomascube
2012-01-27 Update requirements list, remove TODO
20 - Mail_mimeDecode 1.5.5 or newer
c4a2264a » thomascube
2012-08-10 Require the latest (yet unrelesed) version of Net_SMTP
21 - Net_SMTP (latest from https://github.com/pear/Net_SMTP/)
50d7d32d » thomascube
2011-02-15 List Net_IDNA2 as required lib
22 - Net_IDNA2 0.1.1 or newer
114cf128 » alecpl
2012-07-23 Update Net_SMTP/Auth_SASL packages to fix Digest-MD5/Cram-MD5 authent…
23 - Auth_SASL 1.0.6 or newer
7d34064c » alecpl
2010-02-03 - small update
24 * php.ini options (see .htaccess file):
535da27c » thomascube
2006-02-19 Updated installation instructions
25 - error_reporting E_ALL & ~E_NOTICE (or lower)
29640bcf » thomascube
2010-02-18 Add (inactive) session.cookie_path line to .htaccess as suggested in …
26 - memory_limit > 16MB (increase as suitable to support large attachments)
06776305 » alecpl
2008-08-08 - updated php.ini settings requirements
27 - file_uploads enabled (for attachment upload features)
28 - session.auto_start disabled
29 - zend.ze1_compatibility_mode disabled
7d34064c » alecpl
2010-02-03 - small update
30 - suhosin.session.encrypt disabled
31 - mbstring.func_overload disabled
140abb0c » alecpl
2011-09-15 - Require magic_quotes_runtime=Off because it modifies data streams (…
32 - magic_quotes_runtime disabled
0b6d022e » alecpl
2012-06-04 Fix magic_quotes_sybase handling (#1488506)
33 - magic_quotes_sybase disabled
3a01c39a » alecpl
2008-06-15 - small doc fixed (#1485133)
34 * PHP compiled with OpenSSL to connect to IMAPS and to use the spell checker
94fe9ca1 » alecpl
2010-03-06 - re-fix (#1486474) + require MySQL 4.0.8 + add index/update in ident…
35 * A MySQL (4.0.8 or newer), PostgreSQL, MSSQL database engine
d239ee6d » alecpl
2012-07-06 Add PDO to requirements, remove MDB2 package
36 or SQLite support in PHP
1fb2c8e6 » thomascube
2007-11-19 Cast to array because this could be empty; update requirements descri…
37 * One of the above databases with permission to create tables
7d34064c » alecpl
2010-02-03 - small update
38 * An SMTP server (recommended) or PHP configured for mail delivery
535da27c » thomascube
2006-02-19 Updated installation instructions
39
40
4e17e6c9 » thomascube
2005-09-25 Initial revision
41 INSTALLATION
42 ============
43
44 1. Decompress and put this folder somewhere inside your document root
10a69975 » thomascube
2005-11-06 Added localized messages to client and check form input
45 2. Make sure that the following directories (and the files within)
46 are writable by the webserver
4e17e6c9 » thomascube
2005-09-25 Initial revision
47 - /temp
48 - /logs
e019f2d0 » alecpl
2010-09-25 - s/RoundCube/Roundcube/
49 3. Create a new database and a database user for Roundcube (see DATABASE SETUP)
967b3420 » thomascube
2008-03-28 Disable installer by default; add config option to enable it again
50 4. Point your browser to http://url-to-roundcube/installer/
b8ae99a6 » alecpl
2009-08-28 - Fix endless loop on error response for APPEND command (#1486060)
51 5. Follow the instructions of the install script (or see MANUAL CONFIGURATION)
190e97e8 » thomascube
2008-02-26 Fix database initialization and check write access on the DB; update …
52 6. After creating and testing the configuration, remove the installer directory
42b11351 » thomascube
2005-10-07 Several bugfixes and feature improvements
53 7. Done!
54
55
4b20e287 » thomascube
2009-08-27 Don't set php_value error_log in .htaccess by default
56 CONFIGURATION HINTS
57 ===================
58
23362230 » thomascube
2010-04-20 Replace ALTER TABLE statement in Sqlite schema update script; more pr…
59 Roundcube writes internal errors to the 'errors' log file located in the logs
4b20e287 » thomascube
2009-08-27 Don't set php_value error_log in .htaccess by default
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
29640bcf » thomascube
2010-02-18 Add (inactive) session.cookie_path line to .htaccess as suggested in …
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
4b20e287 » thomascube
2009-08-27 Don't set php_value error_log in .htaccess by default
69
10a69975 » thomascube
2005-11-06 Added localized messages to client and check form input
70 DATABASE SETUP
71 ==============
72
23362230 » thomascube
2010-04-20 Replace ALTER TABLE statement in Sqlite schema update script; more pr…
73 Note: Database for Roundcube must use UTF-8 character set.
0ba548a8 » alecpl
2009-11-04 - add precise note about UTF-8 in database
74
fa898a4a » thomascube
2008-11-29 Simplify MYSQL database initialization instructions
75 * MySQL
76 -------
10a69975 » thomascube
2005-11-06 Added localized messages to client and check form input
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
ad56004c » alecpl
2009-02-16 - added info to create unicode database (#1485687)
82 > CREATE DATABASE roundcubemail /*!40101 CHARACTER SET utf8 COLLATE utf8_general_ci */;
10a69975 » thomascube
2005-11-06 Added localized messages to client and check form input
83 > GRANT ALL PRIVILEGES ON roundcubemail.* TO roundcube@localhost
6ae6e41f » thomascube
2007-05-17 Updated description files and version info
84 IDENTIFIED BY 'password';
10a69975 » thomascube
2005-11-06 Added localized messages to client and check form input
85 > quit
aade7b98 » thomascube
2006-08-06 Finalized 0.1beta2 release
86
fa898a4a » thomascube
2008-11-29 Simplify MYSQL database initialization instructions
87 # mysql roundcubemail < SQL/mysql.initial.sql
535da27c » thomascube
2006-02-19 Updated installation instructions
88
fa898a4a » thomascube
2008-11-29 Simplify MYSQL database initialization instructions
89 Note 1: 'password' is the master password for the roundcube user. It is strongly
3cf66493 » thomascube
2007-03-21 Minor bugfixes posted to the dev-mailing list
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
1cded857 » thomascube
2005-12-03 Re-design of caching (new database table added\!); some bugfixes; Pos…
93
10a69975 » thomascube
2005-11-06 Added localized messages to client and check form input
94 * SQLite
95 --------
50d515a7 » alecpl
2009-05-02 - some hints to use sqlite db (#1485821)
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
10a69975 » thomascube
2005-11-06 Added localized messages to client and check form input
98 an example how you can setup the sqlite.db for roundcube:
99
100 # sqlite -init SQL/sqlite.initial.sql sqlite.db
d7f49d64 » thomascube
2009-05-28 Speedup UI by using CSS sprites and etags/expires/deflate for static …
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
10a69975 » thomascube
2005-11-06 Added localized messages to client and check form input
106
107 Make sure your configuration points to the sqlite.db file and that the
83ce4bb0 » thomascube
2008-02-18 Correct/clarify installation hints
108 webserver can write to the file and the directory containing the file.
10a69975 » thomascube
2005-11-06 Added localized messages to client and check form input
109
110
1cded857 » thomascube
2005-12-03 Re-design of caching (new database table added\!); some bugfixes; Pos…
111 * PostgreSQL
112 ------------
23362230 » thomascube
2010-04-20 Replace ALTER TABLE statement in Sqlite schema update script; more pr…
113 To use Roundcube with PostgreSQL support you have to follow these
a898459b » thomascube
2007-11-25 Fix wrong Postgres setup instructions in INSTALL
114 simple steps, which have to be done as the postgres system user (or
1cded857 » thomascube
2005-12-03 Re-design of caching (new database table added\!); some bugfixes; Pos…
115 which ever is the database superuser):
116
a898459b » thomascube
2007-11-25 Fix wrong Postgres setup instructions in INSTALL
117 $ createuser roundcube
ad56004c » alecpl
2009-02-16 - added info to create unicode database (#1485687)
118 $ createdb -O roundcube -E UNICODE roundcubemail
1cded857 » thomascube
2005-12-03 Re-design of caching (new database table added\!); some bugfixes; Pos…
119 $ psql roundcubemail
120
121 roundcubemail =# ALTER USER roundcube WITH PASSWORD 'the_new_password';
a898459b » thomascube
2007-11-25 Fix wrong Postgres setup instructions in INSTALL
122 roundcubemail =# \c - roundcube
1cded857 » thomascube
2005-12-03 Re-design of caching (new database table added\!); some bugfixes; Pos…
123 roundcubemail => \i SQL/postgres.initial.sql
124
a898459b » thomascube
2007-11-25 Fix wrong Postgres setup instructions in INSTALL
125 All this has been tested with PostgreSQL 8.x and 7.4.x. Older
1cded857 » thomascube
2005-12-03 Re-design of caching (new database table added\!); some bugfixes; Pos…
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
23362230 » thomascube
2010-04-20 Replace ALTER TABLE statement in Sqlite schema update script; more pr…
130 Database cleaning
131 -----------------
132 Do keep your database slick and clean we recommend to periodically execute
30aa4cca » alecpl
2010-05-18 - Renamed all php-cli scripts to use .sh extension
133 bin/cleandb.sh which finally removes all records that are marked as deleted.
23362230 » thomascube
2010-04-20 Replace ALTER TABLE statement in Sqlite schema update script; more pr…
134 Best solution is to install a cronjob running this script daily.
135
136
137
190e97e8 » thomascube
2008-02-26 Fix database initialization and check write access on the DB; update …
138 MANUAL CONFIGURATION
139 ====================
535da27c » thomascube
2006-02-19 Updated installation instructions
140
a898459b » thomascube
2007-11-25 Fix wrong Postgres setup instructions in INSTALL
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.
190e97e8 » thomascube
2008-02-26 Fix database initialization and check write access on the DB; update …
144 See http://trac.roundcube.net/wiki/Howto_Install for even more guidance.
535da27c » thomascube
2006-02-19 Updated installation instructions
145
4b9efbb9 » svncommit
2007-08-09 Fixes interface lock-up issues and minor bugs (richs)
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
535da27c » thomascube
2006-02-19 Updated installation instructions
149
83ce4bb0 » thomascube
2008-02-18 Correct/clarify installation hints
150
42b11351 » thomascube
2005-10-07 Several bugfixes and feature improvements
151 UPGRADING
152 =========
6ae6e41f » thomascube
2007-05-17 Updated description files and version info
153
23362230 » thomascube
2010-04-20 Replace ALTER TABLE statement in Sqlite schema update script; more pr…
154 If you already have a previous version of Roundcube installed,
42b11351 » thomascube
2005-10-07 Several bugfixes and feature improvements
155 please refer to the instructions in UPGRADING guide.
4e17e6c9 » thomascube
2005-09-25 Initial revision
156
157
d7f49d64 » thomascube
2009-05-28 Speedup UI by using CSS sprites and etags/expires/deflate for static …
158 OPTIMISING
159 ==========
160
161 There are two forms of optimisation here, compression and caching, both aimed
23362230 » thomascube
2010-04-20 Replace ALTER TABLE statement in Sqlite schema update script; more pr…
162 at increasing an end user's experience using Roundcube Webmail. Compression
d7f49d64 » thomascube
2009-05-28 Speedup UI by using CSS sprites and etags/expires/deflate for static …
163 allows the static web pages to be delivered with less bandwidth. The index.php
23362230 » thomascube
2010-04-20 Replace ALTER TABLE statement in Sqlite schema update script; more pr…
164 of Roundcube Webmail already enables compression on its output. The settings
d7f49d64 » thomascube
2009-05-28 Speedup UI by using CSS sprites and etags/expires/deflate for static …
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:
a5c2ad25 » alecpl
2009-05-29 - corrected apache modules names
192 * mod_deflate
193 * mod_expires
d7f49d64 » thomascube
2009-05-28 Speedup UI by using CSS sprites and etags/expires/deflate for static …
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.