Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 121 lines (89 sloc) 3.937 kb
4e17e6c @thomascube Initial revision
thomascube authored
1
535da27 @thomascube Updated installation instructions
thomascube authored
2 REQUIREMENTS
3 ============
4
1fb2c8e @thomascube Cast to array because this could be empty; update requirements descripti...
thomascube authored
5 * The Apache or Lighttpd Webserver
535da27 @thomascube Updated installation instructions
thomascube authored
6 * .htaccess support allowing overrides for DirectoryIndex
1fb2c8e @thomascube Cast to array because this could be empty; update requirements descripti...
thomascube authored
7 * PHP Version 4.3.1 or greater including
8 - PCRE (perl compatible regular expression)
9 - libiconv (recommended)
10 - mbstring (optional)
535da27 @thomascube Updated installation instructions
thomascube authored
11 * php.ini options:
12 - error_reporting E_ALL & ~E_NOTICE (or lower)
13 - file_uploads on (for attachment upload features)
25d8ba6 Misc bug and compatibility fixes
svncommit authored
14 - memory_limit (increase as suitable to support large attachments)
e9ac143 @thomascube Copy changes from r892 and r903
thomascube authored
15 * PHP compiled with Open SSL to connect to IMAPS and to use the spell checker
535da27 @thomascube Updated installation instructions
thomascube authored
16 * 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
17 * One of the above databases with permission to create tables
18 * An SMTP server or PHP configured for mail delivery
535da27 @thomascube Updated installation instructions
thomascube authored
19
20
4e17e6c @thomascube Initial revision
thomascube authored
21 INSTALLATION
22 ============
23
24 1. Decompress and put this folder somewhere inside your document root
10a6997 @thomascube Added localized messages to client and check form input
thomascube authored
25 2. Make sure that the following directories (and the files within)
26 are writable by the webserver
4e17e6c @thomascube Initial revision
thomascube authored
27 - /temp
28 - /logs
10a6997 @thomascube Added localized messages to client and check form input
thomascube authored
29 3. Create a new database and a database user for RoundCube (see DATABASE SETUP)
42b1135 @thomascube Several bugfixes and feature improvements
thomascube authored
30 4. Create database tables using the queries in file 'SQL/*.initial.sql'
10a6997 @thomascube Added localized messages to client and check form input
thomascube authored
31 (* stands for your database type)
42b1135 @thomascube Several bugfixes and feature improvements
thomascube authored
32 5. Rename the files config/*.inc.php.dist to config/*.inc.php
33 6. Modify the files in config/* to suit your local environment
34 7. Done!
35
36
10a6997 @thomascube Added localized messages to client and check form input
thomascube authored
37 DATABASE SETUP
38 ==============
39
aade7b9 @thomascube Finalized 0.1beta2 release
thomascube authored
40 * MySQL 4.0.x
41 -------------
10a6997 @thomascube Added localized messages to client and check form input
thomascube authored
42 Setting up the mysql database can be done by creating an empty database,
43 importing the table layout and granting the proper permissions to the
44 roundcube user. Here is an example of that procedure:
45
46 # mysql
f7bfec9 @thomascube Finalized new message parsing. Attention: changes in database schema
thomascube authored
47 > CREATE DATABASE roundcubemail;
10a6997 @thomascube Added localized messages to client and check form input
thomascube authored
48 > GRANT ALL PRIVILEGES ON roundcubemail.* TO roundcube@localhost
6ae6e41 @thomascube Updated description files and version info
thomascube authored
49 IDENTIFIED BY 'password';
10a6997 @thomascube Added localized messages to client and check form input
thomascube authored
50 > quit
51 # mysql roundcubemail < SQL/mysql.initial.sql
52
aade7b9 @thomascube Finalized 0.1beta2 release
thomascube authored
53
54 * MySQL 4.1.x/5.x
55 -----------------
535da27 @thomascube Updated installation instructions
thomascube authored
56 For MySQL version 4.1 and up, it's recommended to create the database for
aade7b9 @thomascube Finalized 0.1beta2 release
thomascube authored
57 RoundCube with utf-8 charset. Here's an example of the init procedure:
58
59 # mysql
f7bfec9 @thomascube Finalized new message parsing. Attention: changes in database schema
thomascube authored
60 > CREATE DATABASE roundcubemail DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci;
aade7b9 @thomascube Finalized 0.1beta2 release
thomascube authored
61 > GRANT ALL PRIVILEGES ON roundcubemail.* TO roundcube@localhost
6ae6e41 @thomascube Updated description files and version info
thomascube authored
62 IDENTIFIED BY 'password';
aade7b9 @thomascube Finalized 0.1beta2 release
thomascube authored
63 > quit
64
65 # mysql roundcubemail < SQL/mysql5.initial.sql
535da27 @thomascube Updated installation instructions
thomascube authored
66
3cf6649 @thomascube Minor bugfixes posted to the dev-mailing list
thomascube authored
67 Note: 'password' is the master password for the roundcube user. It is strongly
68 recommended you replace this with a more secure password. Please keep in
69 mind: You need to specify this password later in 'config/db.inc.php'.
70
1cded85 @thomascube Re-design of caching (new database table added\!); some bugfixes; Postgr...
thomascube authored
71
10a6997 @thomascube Added localized messages to client and check form input
thomascube authored
72 * SQLite
73 --------
74 Sqlite requires specifically php5 (sqlite in php4 currently doesn't
75 work with roundcube), and you need sqlite 2 (preferably 2.8) to setup
76 the sqlite db (sqlite 3.x also doesn't work at the moment). Here is
77 an example how you can setup the sqlite.db for roundcube:
78
79 # sqlite -init SQL/sqlite.initial.sql sqlite.db
80
81 Make sure your configuration points to the sqlite.db file and that the
82 webserver can write to the file.
83
84
1cded85 @thomascube Re-design of caching (new database table added\!); some bugfixes; Postgr...
thomascube authored
85 * PostgreSQL
86 ------------
87 To use RoundCube with PostgreSQL support you have to follow the next
88 simple steps, which have to be done with the postgres system user (or
89 which ever is the database superuser):
90
91 $ createuser roundcubemail
92 $ createdb -O roundcubemail roundcubemail
93 $ psql roundcubemail
94
95 roundcubemail =# ALTER USER roundcube WITH PASSWORD 'the_new_password';
96 roundcubemail =# \c - roundcubemail
97 roundcubemail => \i SQL/postgres.initial.sql
98
99 All this has been tested with PostgreSQL 8.0.x and 7.4.x. Older
100 versions don't have a -O option for the createdb, so if you are
101 using that version you'll have to change ownership of the DB later.
102
103
535da27 @thomascube Updated installation instructions
thomascube authored
104 CONFIGURATION
105 =============
106
107 Change the files in config/* according your to environment and your needs.
108 Details about the config paramaters can be found in the config files.
109
4b9efbb Fixes interface lock-up issues and minor bugs (richs)
svncommit authored
110 You can also modify the default .htaccess file. This is necessary to
111 increase the allowed size of file attachments, for example:
112 php_value upload_max_filesize 2M
535da27 @thomascube Updated installation instructions
thomascube authored
113
42b1135 @thomascube Several bugfixes and feature improvements
thomascube authored
114 UPGRADING
115 =========
6ae6e41 @thomascube Updated description files and version info
thomascube authored
116
42b1135 @thomascube Several bugfixes and feature improvements
thomascube authored
117 If you already have a previous version of RoundCube installed,
118 please refer to the instructions in UPGRADING guide.
4e17e6c @thomascube Initial revision
thomascube authored
119
120
Something went wrong with that request. Please try again.