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
6 wiki page at http://trac.roundcube.net/wiki
12 * The Apache or Lighttpd Webserver
13 * .htaccess support allowing overrides for DirectoryIndex
14 * PHP Version 5.2 or greater including
15 - PCRE (perl compatible regular expression)
17 - Multibyte String (mbstring)
18 - Mcrypt (supporting Triple DES)
19 - Database driver for either MySQL, Postgres or SQLite
21 - error_reporting E_ALL & ~E_NOTICE (or lower)
22 - file_uploads on (for attachment upload features)
23 - memory_limit (increase as suitable to support large attachments)
24 - session.auto_start needs to be off/0
25 * The PEAR framework with the following packages installed
29 * PHP compiled with Open SSL to connect to IMAPS and to use the spell checker
30 * A MySQL or PostgreSQL database engine or the SQLite extension for PHP
31 * One of the above databases with permission to create tables
32 * An SMTP server or PHP configured for mail delivery
38 1. Decompress and put this folder somewhere inside your document root
39 2. Make sure that the following directories (and the files within)
40 are writable by the webserver
43 3. Create a new database and a database user for RoundCube (see DATABASE SETUP)
44 4. Point your browser to http://url-to-roundcube/installer/
45 5. Follow the instructions of the install script (or see MANUAL CONFINGURATION)
46 6. After creating and testing the configuration, remove the installer directory
55 Setting up the mysql database can be done by creating an empty database,
56 importing the table layout and granting the proper permissions to the
57 roundcube user. Here is an example of that procedure:
60 > CREATE DATABASE roundcubemail;
61 > GRANT ALL PRIVILEGES ON roundcubemail.* TO roundcube@localhost
62 IDENTIFIED BY 'password';
64 # mysql roundcubemail < SQL/mysql.initial.sql
69 For MySQL version 4.1 and up, it's recommended to create the database for
70 RoundCube with utf-8 charset. Here's an example of the init procedure:
73 > CREATE DATABASE roundcubemail DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci;
74 > GRANT ALL PRIVILEGES ON roundcubemail.* TO roundcube@localhost
75 IDENTIFIED BY 'password';
78 # mysql roundcubemail < SQL/mysql5.initial.sql
80 Note: 'password' is the master password for the roundcube user. It is strongly
81 recommended you replace this with a more secure password. Please keep in
82 mind: You need to specify this password later in 'config/db.inc.php'.
87 Sqlite requires specifically php5 (sqlite in php4 currently doesn't
88 work with roundcube), and you need sqlite 2 (preferably 2.8) to setup
89 the sqlite db (sqlite 3.x also doesn't work at the moment). Here is
90 an example how you can setup the sqlite.db for roundcube:
92 # sqlite -init SQL/sqlite.initial.sql sqlite.db
94 Make sure your configuration points to the sqlite.db file and that the
95 webserver can write to the file and the directory containing the file.
100 To use RoundCube with PostgreSQL support you have to follow these
101 simple steps, which have to be done as the postgres system user (or
102 which ever is the database superuser):
104 $ createuser roundcube
105 $ createdb -O roundcube roundcubemail
108 roundcubemail =# ALTER USER roundcube WITH PASSWORD 'the_new_password';
109 roundcubemail =# \c - roundcube
110 roundcubemail => \i SQL/postgres.initial.sql
112 All this has been tested with PostgreSQL 8.x and 7.4.x. Older
113 versions don't have a -O option for the createdb, so if you are
114 using that version you'll have to change ownership of the DB later.
120 First of all, rename the files config/*.inc.php.dist to config/*.inc.php.
121 You can then change these files according to your environment and your needs.
122 Details about the config parameters can be found in the config files.
123 See http://trac.roundcube.net/wiki/Howto_Install for even more guidance.
125 You can also modify the default .htaccess file. This is necessary to
126 increase the allowed size of file attachments, for example:
127 php_value upload_max_filesize 2M
133 If you already have a previous version of RoundCube installed,
134 please refer to the instructions in UPGRADING guide.