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