Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 204 lines (153 sloc) 7.301 kb
a898459 @thomascube Fix wrong Postgres setup instructions in INSTALL
thomascube authored
1 INTRODUCTION
2 ============
3
4 This file describes the basic steps to install RoundCube Webmail on your
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
1fb2c8e @thomascube Cast to array because this could be empty; update requirements descripti...
thomascube authored
12 * The Apache or Lighttpd Webserver
535da27 @thomascube Updated installation instructions
thomascube authored
13 * .htaccess support allowing overrides for DirectoryIndex
47124c2 @thomascube Changed codebase to PHP5 with autoloader + added some new classes from t...
thomascube authored
14 * PHP Version 5.2 or greater including
1fb2c8e @thomascube Cast to array because this could be empty; update requirements descripti...
thomascube authored
15 - PCRE (perl compatible regular expression)
5d725ed @thomascube Mention dependency of the DOM exension and add link to php.net
thomascube authored
16 - DOM (xml document object model)
1fb2c8e @thomascube Cast to array because this could be empty; update requirements descripti...
thomascube authored
17 - libiconv (recommended)
18 - mbstring (optional)
535da27 @thomascube Updated installation instructions
thomascube authored
19 * php.ini options:
20 - error_reporting E_ALL & ~E_NOTICE (or lower)
25d8ba6 Misc bug and compatibility fixes
svncommit authored
21 - memory_limit (increase as suitable to support large attachments)
0677630 @alecpl - updated php.ini settings requirements
alecpl authored
22 - file_uploads enabled (for attachment upload features)
23 - session.auto_start disabled
24 - zend.ze1_compatibility_mode disabled
3a01c39 @alecpl - small doc fixed (#1485133)
alecpl authored
25 * PHP compiled with OpenSSL to connect to IMAPS and to use the spell checker
535da27 @thomascube Updated installation instructions
thomascube authored
26 * A MySQL or PostgreSQL database engine or the SQLite extension for PHP
1fb2c8e @thomascube Cast to array because this could be empty; update requirements descripti...
thomascube authored
27 * One of the above databases with permission to create tables
28 * An SMTP server or PHP configured for mail delivery
535da27 @thomascube Updated installation instructions
thomascube authored
29
30
4e17e6c @thomascube Initial revision
thomascube authored
31 INSTALLATION
32 ============
33
34 1. Decompress and put this folder somewhere inside your document root
10a6997 @thomascube Added localized messages to client and check form input
thomascube authored
35 2. Make sure that the following directories (and the files within)
36 are writable by the webserver
4e17e6c @thomascube Initial revision
thomascube authored
37 - /temp
38 - /logs
10a6997 @thomascube Added localized messages to client and check form input
thomascube authored
39 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
40 4. Point your browser to http://url-to-roundcube/installer/
190e97e @thomascube Fix database initialization and check write access on the DB; update INS...
thomascube authored
41 5. Follow the instructions of the install script (or see MANUAL CONFINGURATION)
42 6. After creating and testing the configuration, remove the installer directory
42b1135 @thomascube Several bugfixes and feature improvements
thomascube authored
43 7. Done!
44
45
10a6997 @thomascube Added localized messages to client and check form input
thomascube authored
46 DATABASE SETUP
47 ==============
48
fa898a4 @thomascube Simplify MYSQL database initialization instructions
thomascube authored
49 * MySQL
50 -------
10a6997 @thomascube Added localized messages to client and check form input
thomascube authored
51 Setting up the mysql database can be done by creating an empty database,
52 importing the table layout and granting the proper permissions to the
53 roundcube user. Here is an example of that procedure:
54
55 # mysql
ad56004 @alecpl - added info to create unicode database (#1485687)
alecpl authored
56 > CREATE DATABASE roundcubemail /*!40101 CHARACTER SET utf8 COLLATE utf8_general_ci */;
10a6997 @thomascube Added localized messages to client and check form input
thomascube authored
57 > GRANT ALL PRIVILEGES ON roundcubemail.* TO roundcube@localhost
6ae6e41 @thomascube Updated description files and version info
thomascube authored
58 IDENTIFIED BY 'password';
10a6997 @thomascube Added localized messages to client and check form input
thomascube authored
59 > quit
aade7b9 @thomascube Finalized 0.1beta2 release
thomascube authored
60
fa898a4 @thomascube Simplify MYSQL database initialization instructions
thomascube authored
61 # mysql roundcubemail < SQL/mysql.initial.sql
535da27 @thomascube Updated installation instructions
thomascube authored
62
fa898a4 @thomascube Simplify MYSQL database initialization instructions
thomascube authored
63 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
64 recommended you replace this with a more secure password. Please keep in
65 mind: You need to specify this password later in 'config/db.inc.php'.
66
fa898a4 @thomascube Simplify MYSQL database initialization instructions
thomascube authored
67 Note 2: For MySQL version 4.1 and up, it's recommended to create the database for
68 RoundCube with utf-8 charset.
69
1cded85 @thomascube Re-design of caching (new database table added\!); some bugfixes; Postgr...
thomascube authored
70
10a6997 @thomascube Added localized messages to client and check form input
thomascube authored
71 * SQLite
72 --------
50d515a @alecpl - some hints to use sqlite db (#1485821)
alecpl authored
73 You need sqlite 2 (preferably 2.8) to setup the sqlite db
74 (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
75 an example how you can setup the sqlite.db for roundcube:
76
77 # sqlite -init SQL/sqlite.initial.sql sqlite.db
d7f49d6 @thomascube Speedup UI by using CSS sprites and etags/expires/deflate for static fil...
thomascube authored
78 Loading resources from SQL/sqlite.initial.sql
79 SQLite version 2.8.16
80 Enter ".help" for instructions
81 sqlite> .exit
82 # chmod o+rw sqlite.db
10a6997 @thomascube Added localized messages to client and check form input
thomascube authored
83
84 Make sure your configuration points to the sqlite.db file and that the
83ce4bb @thomascube Correct/clarify installation hints
thomascube authored
85 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
86
87
1cded85 @thomascube Re-design of caching (new database table added\!); some bugfixes; Postgr...
thomascube authored
88 * PostgreSQL
89 ------------
a898459 @thomascube Fix wrong Postgres setup instructions in INSTALL
thomascube authored
90 To use RoundCube with PostgreSQL support you have to follow these
91 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; Postgr...
thomascube authored
92 which ever is the database superuser):
93
a898459 @thomascube Fix wrong Postgres setup instructions in INSTALL
thomascube authored
94 $ createuser roundcube
ad56004 @alecpl - added info to create unicode database (#1485687)
alecpl authored
95 $ createdb -O roundcube -E UNICODE roundcubemail
1cded85 @thomascube Re-design of caching (new database table added\!); some bugfixes; Postgr...
thomascube authored
96 $ psql roundcubemail
97
98 roundcubemail =# ALTER USER roundcube WITH PASSWORD 'the_new_password';
a898459 @thomascube Fix wrong Postgres setup instructions in INSTALL
thomascube authored
99 roundcubemail =# \c - roundcube
1cded85 @thomascube Re-design of caching (new database table added\!); some bugfixes; Postgr...
thomascube authored
100 roundcubemail => \i SQL/postgres.initial.sql
101
a898459 @thomascube Fix wrong Postgres setup instructions in INSTALL
thomascube authored
102 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; Postgr...
thomascube authored
103 versions don't have a -O option for the createdb, so if you are
104 using that version you'll have to change ownership of the DB later.
105
106
190e97e @thomascube Fix database initialization and check write access on the DB; update INS...
thomascube authored
107 MANUAL CONFIGURATION
108 ====================
535da27 @thomascube Updated installation instructions
thomascube authored
109
a898459 @thomascube Fix wrong Postgres setup instructions in INSTALL
thomascube authored
110 First of all, rename the files config/*.inc.php.dist to config/*.inc.php.
111 You can then change these files according to your environment and your needs.
112 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 INS...
thomascube authored
113 See http://trac.roundcube.net/wiki/Howto_Install for even more guidance.
535da27 @thomascube Updated installation instructions
thomascube authored
114
4b9efbb Fixes interface lock-up issues and minor bugs (richs)
svncommit authored
115 You can also modify the default .htaccess file. This is necessary to
116 increase the allowed size of file attachments, for example:
117 php_value upload_max_filesize 2M
535da27 @thomascube Updated installation instructions
thomascube authored
118
83ce4bb @thomascube Correct/clarify installation hints
thomascube authored
119
42b1135 @thomascube Several bugfixes and feature improvements
thomascube authored
120 UPGRADING
121 =========
6ae6e41 @thomascube Updated description files and version info
thomascube authored
122
42b1135 @thomascube Several bugfixes and feature improvements
thomascube authored
123 If you already have a previous version of RoundCube installed,
124 please refer to the instructions in UPGRADING guide.
4e17e6c @thomascube Initial revision
thomascube authored
125
126
d7f49d6 @thomascube Speedup UI by using CSS sprites and etags/expires/deflate for static fil...
thomascube authored
127 OPTIMISING
128 ==========
129
130 There are two forms of optimisation here, compression and caching, both aimed
131 at increasing an end user's experience using RoundCube Webmail. Compression
132 allows the static web pages to be delivered with less bandwidth. The index.php
133 of RoundCube Webmail already enables compression on its output. The settings
134 below allow compression to occur for all static files. Caching sets HTTP
135 response headers that enable a user's web client to understand what is static
136 and how to cache it.
137
138 The caching directives used are:
139 * Etags - sets at tag so the client can request is the page has changed
140 * Cache-control - defines the age of the page and that the page is 'public'
141 This enables clients to cache javascript files that don't have private
142 information between sessions even if using HTTPS. It also allows proxies
143 to share the same cached page between users.
144 * Expires - provides another hint to increase the lifetime of static pages.
145
146 For more information refer to RFC 2616.
147
148 Side effects:
149 -------------
150 These directives are designed for production use. If you are using this in
151 a development environment you may get horribly confused if your webclient
152 is caching stuff that you changed on the server. Disabling the expires
153 parts below should save you some grief.
154
155 If you are changing the skins, it is recommended that you copy content to
156 a different directory apart from 'default'.
157
158 Apache:
159 -------
160 To enable these features in apache the following modules need to be enabled:
161 * mod_compress
162 * mod_expire
163 * mod_headers
164
165 The optimisation is already included in the .htaccess file in the top
166 directory of your installation.
167
168 If you are using Apache version 2.2.9 and later, in the .htaccess file
169 change the 'append' word to 'merge' for a more correct response. Keeping
170 as 'append' shouldn't cause any problems though changing to merge will
171 eliminate the possibility of duplicate 'public' headers in Cache-control.
172
173 Lighttpd:
174 ---------
175 With Lightty the addition of Expire: tags by mod_expire is incompatible with
176 the addition of "Cache-control: public". Using Cache-control 'public' is
177 used below as it is assumed to give a better caching result.
178
179 Enable modules in server.modules:
180 "mod_setenv"
181 "mod_compress"
182
183 Mod_compress is a server side cache of compressed files to improve its performance.
184
185 $HTTP["host"] == "www.example.com" {
186
187 static-file.etags = "enable"
188 # http://redmine.lighttpd.net/projects/lighttpd/wiki/Etag.use-mtimeDetails
189 etag.use-mtime = "enable"
190
191 # http://redmine.lighttpd.net/projects/lighttpd/wiki/Docs:ModSetEnv
192 $HTTP["url"] =~ "^/roundcubemail/(plugins|skins|program)" {
193 setenv.add-response-header = ( "Cache-Control" => "public, max-age=2592000")
194 }
195
196 # http://redmine.lighttpd.net/projects/lighttpd/wiki/Docs:ModCompress
197 # set compress.cache-dir to somewhere outside the docroot.
198 compress.cache-dir = var.statedir + "/cache/compress"
199
200 compress.filetype = ("text/plain", "text/html", "text/javascript", "text/css", "text/xml", "image/gif", "image/png")
201 }
202
203
Something went wrong with that request. Please try again.