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