| commit | author | age | ||
| 4e17e6 | 1 | |
| T | 2 | INSTALLATION |
| 3 | ============ | |
| 4 | ||
| 5 | 1. Decompress and put this folder somewhere inside your document root | |
| 10a699 | 6 | 2. Make sure that the following directories (and the files within) |
| T | 7 | are writable by the webserver |
| 4e17e6 | 8 | - /temp |
| T | 9 | - /logs |
| 10a699 | 10 | 3. Create a new database and a database user for RoundCube (see DATABASE SETUP) |
| 42b113 | 11 | 4. Create database tables using the queries in file 'SQL/*.initial.sql' |
| 10a699 | 12 | (* stands for your database type) |
| 42b113 | 13 | 5. Rename the files config/*.inc.php.dist to config/*.inc.php |
| T | 14 | 6. Modify the files in config/* to suit your local environment |
| 15 | 7. Done! | |
| 16 | ||
| 17 | ||
| 10a699 | 18 | DATABASE SETUP |
| T | 19 | ============== |
| 20 | ||
| 21 | * MySQL | |
| 22 | ------- | |
| 23 | Setting up the mysql database can be done by creating an empty database, | |
| 24 | importing the table layout and granting the proper permissions to the | |
| 25 | roundcube user. Here is an example of that procedure: | |
| 26 | ||
| 27 | # mysql | |
| 28 | > create database 'roundcubemail'; | |
| 29 | > GRANT ALL PRIVILEGES ON roundcubemail.* TO roundcube@localhost | |
| 30 | IDENTIFIED BY 'password'; | |
| 31 | > quit | |
| 32 | # mysql roundcubemail < SQL/mysql.initial.sql | |
| 33 | ||
| 34 | * SQLite | |
| 35 | -------- | |
| 36 | Sqlite requires specifically php5 (sqlite in php4 currently doesn't | |
| 37 | work with roundcube), and you need sqlite 2 (preferably 2.8) to setup | |
| 38 | the sqlite db (sqlite 3.x also doesn't work at the moment). Here is | |
| 39 | an example how you can setup the sqlite.db for roundcube: | |
| 40 | ||
| 41 | # sqlite -init SQL/sqlite.initial.sql sqlite.db | |
| 42 | ||
| 43 | Make sure your configuration points to the sqlite.db file and that the | |
| 44 | webserver can write to the file. | |
| 45 | ||
| 46 | ||
| 42b113 | 47 | UPGRADING |
| T | 48 | ========= |
| 49 | If you already have a previous version of RoundCube installed, | |
| 50 | please refer to the instructions in UPGRADING guide. | |
| 4e17e6 | 51 | |
| T | 52 | |
| 53 | REQUIREMENTS | |
| 54 | ============ | |
| 55 | ||
| 56 | * The Apache Webserver | |
| 57 | * .htaccess support allowing overrides for DirectoryIndex | |
| 58 | * PHP Version 4.3.1 or greater | |
| 59 | * php.ini options: | |
| 60 | - error_reporting E_ALL & ~E_NOTICE (or lower) | |
| 61 | - file_uploads on (for attachment upload features) | |
| 42b113 | 62 | * A MySQL or PostgreSQL database engine or the SQLite extension for PHP |
| 4e17e6 | 63 | * A database with permission to create tables |
| T | 64 | |
| 65 | ||
| 66 | CONFIGURATION | |
| 67 | ============= | |
| 68 | ||
| 7cc38e | 69 | Change the files in config/* according your to environment and your needs. |
| 4e17e6 | 70 | Details about the config paramaters can be found in the config files. |
