thomascube
2006-06-26 b068a07db2c519cde6bf1715e725cb70f2bbbc35
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)
12 * A MySQL or PostgreSQL database engine or the SQLite extension for PHP
13 * A database with permission to create tables
14
15
4e17e6 16 INSTALLATION
T 17 ============
18
19 1. Decompress and put this folder somewhere inside your document root
10a699 20 2. Make sure that the following directories (and the files within)
T 21    are writable by the webserver
4e17e6 22    - /temp
T 23    - /logs
10a699 24 3. Create a new database and a database user for RoundCube (see DATABASE SETUP)
42b113 25 4. Create database tables using the queries in file 'SQL/*.initial.sql'
10a699 26    (* stands for your database type)
42b113 27 5. Rename the files config/*.inc.php.dist to config/*.inc.php
T 28 6. Modify the files in config/* to suit your local environment
29 7. Done!
30
31
10a699 32 DATABASE SETUP
T 33 ==============
34
35 * MySQL
36 -------
37 Setting up the mysql database can be done by creating an empty database,
38 importing the table layout and granting the proper permissions to the
39 roundcube user. Here is an example of that procedure:
40
41 # mysql
fd3725 42 > CREATE DATABASE 'roundcubemail';
10a699 43 > GRANT ALL PRIVILEGES ON roundcubemail.* TO roundcube@localhost
T 44         IDENTIFIED BY 'password';
45 > quit
46 # mysql roundcubemail < SQL/mysql.initial.sql
535da2 47
T 48 For MySQL version 4.1 and up, it's recommended to create the database for
49 RoundCube with the following command:
fd3725 50 > CREATE DATABASE 'roundcubemail' DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci;
10a699 51
1cded8 52
10a699 53 * SQLite
T 54 --------
55 Sqlite requires specifically php5 (sqlite in php4 currently doesn't
56 work with roundcube), and you need sqlite 2 (preferably 2.8) to setup
57 the sqlite db (sqlite 3.x also doesn't work at the moment). Here is
58 an example how you can setup the sqlite.db for roundcube:
59
60 # sqlite -init SQL/sqlite.initial.sql sqlite.db
61
62 Make sure your configuration points to the sqlite.db file and that the
63 webserver can write to the file.
64
65
1cded8 66 * PostgreSQL
T 67 ------------
68 To use RoundCube with PostgreSQL support you have to follow the next
69 simple steps, which have to be done with the postgres system user (or
70 which ever is the database superuser):
71
72 $ createuser roundcubemail
73 $ createdb -O roundcubemail roundcubemail
74 $ psql roundcubemail
75
76 roundcubemail =# ALTER USER roundcube WITH PASSWORD 'the_new_password';
77 roundcubemail =# \c - roundcubemail
78 roundcubemail => \i SQL/postgres.initial.sql
79
80 All this has been tested with PostgreSQL 8.0.x and 7.4.x. Older
81 versions don't have a -O option for the createdb, so if you are
82 using that version you'll have to change ownership of the DB later.
83
84
535da2 85 CONFIGURATION
T 86 =============
87
88 Change the files in config/* according your to environment and your needs.
89 Details about the config paramaters can be found in the config files.
90
91
42b113 92 UPGRADING
T 93 =========
94 If you already have a previous version of RoundCube installed,
95 please refer to the instructions in UPGRADING guide.
4e17e6 96
T 97