Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 123 lines (90 sloc) 4.118 kb
a898459 Thomas B. 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 Thomas B. Correct/clarify installation hints
thomascube authored
6 wiki page at http://trac.roundcube.net/wiki
7
4e17e6c Thomas B. Initial revision
thomascube authored
8
535da27 Thomas B. Updated installation instructions
thomascube authored
9 REQUIREMENTS
10 ============
11
1fb2c8e Thomas B. Cast to array because this could be empty; update requirements descripti...
thomascube authored
12 * The Apache or Lighttpd Webserver
535da27 Thomas B. Updated installation instructions
thomascube authored
13 * .htaccess support allowing overrides for DirectoryIndex
47124c2 Thomas B. Changed codebase to PHP5 with autoloader + added some new classes from t...
thomascube authored
14 * PHP Version 5.2 or greater including
1fb2c8e Thomas B. Cast to array because this could be empty; update requirements descripti...
thomascube authored
15 - PCRE (perl compatible regular expression)
5d725ed Thomas B. Mention dependency of the DOM exension and add link to php.net
thomascube authored
16 - DOM (xml document object model)
1fb2c8e Thomas B. Cast to array because this could be empty; update requirements descripti...
thomascube authored
17 - libiconv (recommended)
18 - mbstring (optional)
535da27 Thomas B. 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 Aleksander Machniak - 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 Aleksander Machniak - small doc fixed (#1485133)
alecpl authored
25 * PHP compiled with OpenSSL to connect to IMAPS and to use the spell checker
535da27 Thomas B. Updated installation instructions
thomascube authored
26 * A MySQL or PostgreSQL database engine or the SQLite extension for PHP
1fb2c8e Thomas B. 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 Thomas B. Updated installation instructions
thomascube authored
29
30
4e17e6c Thomas B. Initial revision
thomascube authored
31 INSTALLATION
32 ============
33
34 1. Decompress and put this folder somewhere inside your document root
10a6997 Thomas B. 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 Thomas B. Initial revision
thomascube authored
37 - /temp
38 - /logs
10a6997 Thomas B. 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 Thomas B. 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 Thomas B. 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 Thomas B. Several bugfixes and feature improvements
thomascube authored
43 7. Done!
44
45
10a6997 Thomas B. Added localized messages to client and check form input
thomascube authored
46 DATABASE SETUP
47 ==============
48
fa898a4 Thomas B. Simplify MYSQL database initialization instructions
thomascube authored
49 * MySQL
50 -------
10a6997 Thomas B. 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
f7bfec9 Thomas B. Finalized new message parsing. Attention: changes in database schema
thomascube authored
56 > CREATE DATABASE roundcubemail;
10a6997 Thomas B. Added localized messages to client and check form input
thomascube authored
57 > GRANT ALL PRIVILEGES ON roundcubemail.* TO roundcube@localhost
6ae6e41 Thomas B. Updated description files and version info
thomascube authored
58 IDENTIFIED BY 'password';
10a6997 Thomas B. Added localized messages to client and check form input
thomascube authored
59 > quit
aade7b9 Thomas B. Finalized 0.1beta2 release
thomascube authored
60
fa898a4 Thomas B. Simplify MYSQL database initialization instructions
thomascube authored
61 # mysql roundcubemail < SQL/mysql.initial.sql
535da27 Thomas B. Updated installation instructions
thomascube authored
62
fa898a4 Thomas B. Simplify MYSQL database initialization instructions
thomascube authored
63 Note 1: 'password' is the master password for the roundcube user. It is strongly
3cf6649 Thomas B. 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 Thomas B. 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 Thomas B. Re-design of caching (new database table added\!); some bugfixes; Postgr...
thomascube authored
70
10a6997 Thomas B. Added localized messages to client and check form input
thomascube authored
71 * SQLite
72 --------
73 Sqlite requires specifically php5 (sqlite in php4 currently doesn't
74 work with roundcube), and you need sqlite 2 (preferably 2.8) to setup
75 the sqlite db (sqlite 3.x also doesn't work at the moment). Here is
76 an example how you can setup the sqlite.db for roundcube:
77
78 # sqlite -init SQL/sqlite.initial.sql sqlite.db
79
80 Make sure your configuration points to the sqlite.db file and that the
83ce4bb Thomas B. Correct/clarify installation hints
thomascube authored
81 webserver can write to the file and the directory containing the file.
10a6997 Thomas B. Added localized messages to client and check form input
thomascube authored
82
83
1cded85 Thomas B. Re-design of caching (new database table added\!); some bugfixes; Postgr...
thomascube authored
84 * PostgreSQL
85 ------------
a898459 Thomas B. Fix wrong Postgres setup instructions in INSTALL
thomascube authored
86 To use RoundCube with PostgreSQL support you have to follow these
87 simple steps, which have to be done as the postgres system user (or
1cded85 Thomas B. Re-design of caching (new database table added\!); some bugfixes; Postgr...
thomascube authored
88 which ever is the database superuser):
89
a898459 Thomas B. Fix wrong Postgres setup instructions in INSTALL
thomascube authored
90 $ createuser roundcube
91 $ createdb -O roundcube roundcubemail
1cded85 Thomas B. Re-design of caching (new database table added\!); some bugfixes; Postgr...
thomascube authored
92 $ psql roundcubemail
93
94 roundcubemail =# ALTER USER roundcube WITH PASSWORD 'the_new_password';
a898459 Thomas B. Fix wrong Postgres setup instructions in INSTALL
thomascube authored
95 roundcubemail =# \c - roundcube
1cded85 Thomas B. Re-design of caching (new database table added\!); some bugfixes; Postgr...
thomascube authored
96 roundcubemail => \i SQL/postgres.initial.sql
97
a898459 Thomas B. Fix wrong Postgres setup instructions in INSTALL
thomascube authored
98 All this has been tested with PostgreSQL 8.x and 7.4.x. Older
1cded85 Thomas B. Re-design of caching (new database table added\!); some bugfixes; Postgr...
thomascube authored
99 versions don't have a -O option for the createdb, so if you are
100 using that version you'll have to change ownership of the DB later.
101
102
190e97e Thomas B. Fix database initialization and check write access on the DB; update INS...
thomascube authored
103 MANUAL CONFIGURATION
104 ====================
535da27 Thomas B. Updated installation instructions
thomascube authored
105
a898459 Thomas B. Fix wrong Postgres setup instructions in INSTALL
thomascube authored
106 First of all, rename the files config/*.inc.php.dist to config/*.inc.php.
107 You can then change these files according to your environment and your needs.
108 Details about the config parameters can be found in the config files.
190e97e Thomas B. Fix database initialization and check write access on the DB; update INS...
thomascube authored
109 See http://trac.roundcube.net/wiki/Howto_Install for even more guidance.
535da27 Thomas B. Updated installation instructions
thomascube authored
110
4b9efbb Fixes interface lock-up issues and minor bugs (richs)
svncommit authored
111 You can also modify the default .htaccess file. This is necessary to
112 increase the allowed size of file attachments, for example:
113 php_value upload_max_filesize 2M
535da27 Thomas B. Updated installation instructions
thomascube authored
114
83ce4bb Thomas B. Correct/clarify installation hints
thomascube authored
115
42b1135 Thomas B. Several bugfixes and feature improvements
thomascube authored
116 UPGRADING
117 =========
6ae6e41 Thomas B. Updated description files and version info
thomascube authored
118
42b1135 Thomas B. Several bugfixes and feature improvements
thomascube authored
119 If you already have a previous version of RoundCube installed,
120 please refer to the instructions in UPGRADING guide.
4e17e6c Thomas B. Initial revision
thomascube authored
121
122
Something went wrong with that request. Please try again.