thomascube
2007-10-17 57456485c477d2f493b4ecd69a3608fe1ad2dcbf
commit | author | age
4e17e6 1
535da2 2 REQUIREMENTS
T 3 ============
4
5 * The Apache Webserver
6 * .htaccess support allowing overrides for DirectoryIndex
7 * PHP Version 4.3.1 or greater
8 * PCRE (perl compatible regular expression) installed with PHP
9 * php.ini options:
10    - error_reporting E_ALL & ~E_NOTICE (or lower)
11    - file_uploads on (for attachment upload features)
25d8ba 12    - memory_limit (increase as suitable to support large attachments)
535da2 13 * A MySQL or PostgreSQL database engine or the SQLite extension for PHP
T 14 * A database with permission to create tables
15
16
4e17e6 17 INSTALLATION
T 18 ============
19
20 1. Decompress and put this folder somewhere inside your document root
10a699 21 2. Make sure that the following directories (and the files within)
T 22    are writable by the webserver
4e17e6 23    - /temp
T 24    - /logs
10a699 25 3. Create a new database and a database user for RoundCube (see DATABASE SETUP)
42b113 26 4. Create database tables using the queries in file 'SQL/*.initial.sql'
10a699 27    (* stands for your database type)
42b113 28 5. Rename the files config/*.inc.php.dist to config/*.inc.php
T 29 6. Modify the files in config/* to suit your local environment
30 7. Done!
31
32
10a699 33 DATABASE SETUP
T 34 ==============
35
aade7b 36 * MySQL 4.0.x
T 37 -------------
10a699 38 Setting up the mysql database can be done by creating an empty database,
T 39 importing the table layout and granting the proper permissions to the
40 roundcube user. Here is an example of that procedure:
41
42 # mysql
f7bfec 43 > CREATE DATABASE roundcubemail;
10a699 44 > GRANT ALL PRIVILEGES ON roundcubemail.* TO roundcube@localhost
6ae6e4 45     IDENTIFIED BY 'password';
10a699 46 > quit
T 47 # mysql roundcubemail < SQL/mysql.initial.sql
535da2 48
aade7b 49
T 50 * MySQL 4.1.x/5.x
51 -----------------
535da2 52 For MySQL version 4.1 and up, it's recommended to create the database for
aade7b 53 RoundCube with utf-8 charset. Here's an example of the init procedure:
T 54
55 # mysql
f7bfec 56 > CREATE DATABASE roundcubemail DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci;
aade7b 57 > GRANT ALL PRIVILEGES ON roundcubemail.* TO roundcube@localhost
6ae6e4 58     IDENTIFIED BY 'password';
aade7b 59 > quit
T 60
61 # mysql roundcubemail < SQL/mysql5.initial.sql
10a699 62
3cf664 63 Note: 'password' is the master password for the roundcube user. It is strongly
T 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
1cded8 67
10a699 68 * SQLite
T 69 --------
70 Sqlite requires specifically php5 (sqlite in php4 currently doesn't
71 work with roundcube), and you need sqlite 2 (preferably 2.8) to setup
72 the sqlite db (sqlite 3.x also doesn't work at the moment). Here is
73 an example how you can setup the sqlite.db for roundcube:
74
75 # sqlite -init SQL/sqlite.initial.sql sqlite.db
76
77 Make sure your configuration points to the sqlite.db file and that the
78 webserver can write to the file.
79
80
1cded8 81 * PostgreSQL
T 82 ------------
83 To use RoundCube with PostgreSQL support you have to follow the next
84 simple steps, which have to be done with the postgres system user (or
85 which ever is the database superuser):
86
87 $ createuser roundcubemail
88 $ createdb -O roundcubemail roundcubemail
89 $ psql roundcubemail
90
91 roundcubemail =# ALTER USER roundcube WITH PASSWORD 'the_new_password';
92 roundcubemail =# \c - roundcubemail
93 roundcubemail => \i SQL/postgres.initial.sql
94
95 All this has been tested with PostgreSQL 8.0.x and 7.4.x. Older
96 versions don't have a -O option for the createdb, so if you are
97 using that version you'll have to change ownership of the DB later.
98
99
535da2 100 CONFIGURATION
T 101 =============
102
103 Change the files in config/* according your to environment and your needs.
104 Details about the config paramaters can be found in the config files.
105
4b9efb 106 You can also modify the default .htaccess file. This is necessary to
S 107 increase the allowed size of file attachments, for example:
108     php_value       upload_max_filesize     2M
535da2 109
42b113 110 UPGRADING
T 111 =========
6ae6e4 112
42b113 113 If you already have a previous version of RoundCube installed,
T 114 please refer to the instructions in UPGRADING guide.
4e17e6 115
T 116