Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 132 lines (97 sloc) 4.402 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)
21 - file_uploads on (for attachment upload features)
25d8ba6 Misc bug and compatibility fixes
svncommit authored
22 - memory_limit (increase as suitable to support large attachments)
5812134 @till * fixed #1484437
till authored
23 - session.auto_start needs to be off/0
3a01c39 @alecpl - small doc fixed (#1485133)
alecpl authored
24 * PHP compiled with OpenSSL to connect to IMAPS and to use the spell checker
535da27 @thomascube Updated installation instructions
thomascube authored
25 * 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
26 * One of the above databases with permission to create tables
27 * An SMTP server or PHP configured for mail delivery
535da27 @thomascube Updated installation instructions
thomascube authored
28
29
4e17e6c @thomascube Initial revision
thomascube authored
30 INSTALLATION
31 ============
32
33 1. Decompress and put this folder somewhere inside your document root
10a6997 @thomascube Added localized messages to client and check form input
thomascube authored
34 2. Make sure that the following directories (and the files within)
35 are writable by the webserver
4e17e6c @thomascube Initial revision
thomascube authored
36 - /temp
37 - /logs
10a6997 @thomascube Added localized messages to client and check form input
thomascube authored
38 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
39 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
40 5. Follow the instructions of the install script (or see MANUAL CONFINGURATION)
41 6. After creating and testing the configuration, remove the installer directory
42b1135 @thomascube Several bugfixes and feature improvements
thomascube authored
42 7. Done!
43
44
10a6997 @thomascube Added localized messages to client and check form input
thomascube authored
45 DATABASE SETUP
46 ==============
47
aade7b9 @thomascube Finalized 0.1beta2 release
thomascube authored
48 * MySQL 4.0.x
49 -------------
10a6997 @thomascube Added localized messages to client and check form input
thomascube authored
50 Setting up the mysql database can be done by creating an empty database,
51 importing the table layout and granting the proper permissions to the
52 roundcube user. Here is an example of that procedure:
53
54 # mysql
f7bfec9 @thomascube Finalized new message parsing. Attention: changes in database schema
thomascube authored
55 > CREATE DATABASE roundcubemail;
10a6997 @thomascube Added localized messages to client and check form input
thomascube authored
56 > GRANT ALL PRIVILEGES ON roundcubemail.* TO roundcube@localhost
6ae6e41 @thomascube Updated description files and version info
thomascube authored
57 IDENTIFIED BY 'password';
10a6997 @thomascube Added localized messages to client and check form input
thomascube authored
58 > quit
59 # mysql roundcubemail < SQL/mysql.initial.sql
60
aade7b9 @thomascube Finalized 0.1beta2 release
thomascube authored
61
62 * MySQL 4.1.x/5.x
63 -----------------
535da27 @thomascube Updated installation instructions
thomascube authored
64 For MySQL version 4.1 and up, it's recommended to create the database for
aade7b9 @thomascube Finalized 0.1beta2 release
thomascube authored
65 RoundCube with utf-8 charset. Here's an example of the init procedure:
66
67 # mysql
f7bfec9 @thomascube Finalized new message parsing. Attention: changes in database schema
thomascube authored
68 > CREATE DATABASE roundcubemail DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci;
aade7b9 @thomascube Finalized 0.1beta2 release
thomascube authored
69 > GRANT ALL PRIVILEGES ON roundcubemail.* TO roundcube@localhost
6ae6e41 @thomascube Updated description files and version info
thomascube authored
70 IDENTIFIED BY 'password';
aade7b9 @thomascube Finalized 0.1beta2 release
thomascube authored
71 > quit
72
73 # mysql roundcubemail < SQL/mysql5.initial.sql
535da27 @thomascube Updated installation instructions
thomascube authored
74
3cf6649 @thomascube Minor bugfixes posted to the dev-mailing list
thomascube authored
75 Note: 'password' is the master password for the roundcube user. It is strongly
76 recommended you replace this with a more secure password. Please keep in
77 mind: You need to specify this password later in 'config/db.inc.php'.
78
1cded85 @thomascube Re-design of caching (new database table added\!); some bugfixes; Postgr...
thomascube authored
79
10a6997 @thomascube Added localized messages to client and check form input
thomascube authored
80 * SQLite
81 --------
82 Sqlite requires specifically php5 (sqlite in php4 currently doesn't
83 work with roundcube), and you need sqlite 2 (preferably 2.8) to setup
84 the sqlite db (sqlite 3.x also doesn't work at the moment). Here is
85 an example how you can setup the sqlite.db for roundcube:
86
87 # sqlite -init SQL/sqlite.initial.sql sqlite.db
88
89 Make sure your configuration points to the sqlite.db file and that the
83ce4bb @thomascube Correct/clarify installation hints
thomascube authored
90 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
91
92
1cded85 @thomascube Re-design of caching (new database table added\!); some bugfixes; Postgr...
thomascube authored
93 * PostgreSQL
94 ------------
a898459 @thomascube Fix wrong Postgres setup instructions in INSTALL
thomascube authored
95 To use RoundCube with PostgreSQL support you have to follow these
96 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
97 which ever is the database superuser):
98
a898459 @thomascube Fix wrong Postgres setup instructions in INSTALL
thomascube authored
99 $ createuser roundcube
100 $ createdb -O roundcube roundcubemail
1cded85 @thomascube Re-design of caching (new database table added\!); some bugfixes; Postgr...
thomascube authored
101 $ psql roundcubemail
102
103 roundcubemail =# ALTER USER roundcube WITH PASSWORD 'the_new_password';
a898459 @thomascube Fix wrong Postgres setup instructions in INSTALL
thomascube authored
104 roundcubemail =# \c - roundcube
1cded85 @thomascube Re-design of caching (new database table added\!); some bugfixes; Postgr...
thomascube authored
105 roundcubemail => \i SQL/postgres.initial.sql
106
a898459 @thomascube Fix wrong Postgres setup instructions in INSTALL
thomascube authored
107 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
108 versions don't have a -O option for the createdb, so if you are
109 using that version you'll have to change ownership of the DB later.
110
111
190e97e @thomascube Fix database initialization and check write access on the DB; update INS...
thomascube authored
112 MANUAL CONFIGURATION
113 ====================
535da27 @thomascube Updated installation instructions
thomascube authored
114
a898459 @thomascube Fix wrong Postgres setup instructions in INSTALL
thomascube authored
115 First of all, rename the files config/*.inc.php.dist to config/*.inc.php.
116 You can then change these files according to your environment and your needs.
117 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
118 See http://trac.roundcube.net/wiki/Howto_Install for even more guidance.
535da27 @thomascube Updated installation instructions
thomascube authored
119
4b9efbb Fixes interface lock-up issues and minor bugs (richs)
svncommit authored
120 You can also modify the default .htaccess file. This is necessary to
121 increase the allowed size of file attachments, for example:
122 php_value upload_max_filesize 2M
535da27 @thomascube Updated installation instructions
thomascube authored
123
83ce4bb @thomascube Correct/clarify installation hints
thomascube authored
124
42b1135 @thomascube Several bugfixes and feature improvements
thomascube authored
125 UPGRADING
126 =========
6ae6e41 @thomascube Updated description files and version info
thomascube authored
127
42b1135 @thomascube Several bugfixes and feature improvements
thomascube authored
128 If you already have a previous version of RoundCube installed,
129 please refer to the instructions in UPGRADING guide.
4e17e6c @thomascube Initial revision
thomascube authored
130
131
Something went wrong with that request. Please try again.