| 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 | ||
| 1cded8 | 34 | |
| 10a699 | 35 | * SQLite |
| T | 36 | -------- |
| 37 | Sqlite requires specifically php5 (sqlite in php4 currently doesn't | |
| 38 | work with roundcube), and you need sqlite 2 (preferably 2.8) to setup | |
| 39 | the sqlite db (sqlite 3.x also doesn't work at the moment). Here is | |
| 40 | an example how you can setup the sqlite.db for roundcube: | |
| 41 | ||
| 42 | # sqlite -init SQL/sqlite.initial.sql sqlite.db | |
| 43 | ||
| 44 | Make sure your configuration points to the sqlite.db file and that the | |
| 45 | webserver can write to the file. | |
| 46 | ||
| 47 | ||
| 1cded8 | 48 | * PostgreSQL |
| T | 49 | ------------ |
| 50 | To use RoundCube with PostgreSQL support you have to follow the next | |
| 51 | simple steps, which have to be done with the postgres system user (or | |
| 52 | which ever is the database superuser): | |
| 53 | ||
| 54 | $ createuser roundcubemail | |
| 55 | $ createdb -O roundcubemail roundcubemail | |
| 56 | $ psql roundcubemail | |
| 57 | ||
| 58 | roundcubemail =# ALTER USER roundcube WITH PASSWORD 'the_new_password'; | |
| 59 | roundcubemail =# \c - roundcubemail | |
| 60 | roundcubemail => \i SQL/postgres.initial.sql | |
| 61 | ||
| 62 | All this has been tested with PostgreSQL 8.0.x and 7.4.x. Older | |
| 63 | versions don't have a -O option for the createdb, so if you are | |
| 64 | using that version you'll have to change ownership of the DB later. | |
| 65 | ||
| 66 | ||
| 42b113 | 67 | UPGRADING |
| T | 68 | ========= |
| 69 | If you already have a previous version of RoundCube installed, | |
| 70 | please refer to the instructions in UPGRADING guide. | |
| 4e17e6 | 71 | |
| T | 72 | |
| 73 | REQUIREMENTS | |
| 74 | ============ | |
| 75 | ||
| 76 | * The Apache Webserver | |
| 77 | * .htaccess support allowing overrides for DirectoryIndex | |
| 78 | * PHP Version 4.3.1 or greater | |
| 79 | * php.ini options: | |
| 80 | - error_reporting E_ALL & ~E_NOTICE (or lower) | |
| 81 | - file_uploads on (for attachment upload features) | |
| 42b113 | 82 | * A MySQL or PostgreSQL database engine or the SQLite extension for PHP |
| 4e17e6 | 83 | * A database with permission to create tables |
| T | 84 | |
| 85 | ||
| 86 | CONFIGURATION | |
| 87 | ============= | |
| 88 | ||
| 7cc38e | 89 | Change the files in config/* according your to environment and your needs. |
| 4e17e6 | 90 | Details about the config paramaters can be found in the config files. |
