New upstream release !

[roundcube.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 0c7e7cbbfeb62a9460e44109ad70c651d6ae86b9..5032e4a428461319cb925754935cad40906d4f10 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -4,12 +4,21 @@ REQUIREMENTS
 
 * The Apache Webserver
 * .htaccess support allowing overrides for DirectoryIndex
-* PHP Version 4.3.1 or greater
-* PCRE (perl compatible regular expression) installed with PHP
+* PHP Version 4.3.1 or greater including
+   - PCRE (perl compatible regular expression)
+   - Mcrypt (supporting Triple DES)
+   - libiconv
+   - Multibyte String (mbstring)
+   - Database driver for either MySQL, Postgres or SQLite 
 * php.ini options:
    - error_reporting E_ALL & ~E_NOTICE (or lower)
    - file_uploads on (for attachment upload features)
    - memory_limit (increase as suitable to support large attachments)
+* The PEAR framework with the following packages installed
+   - DB (1.7.11)
+   - Mail_Mime (1.3.1)
+   - Net_SMTP (1.2.10)
+* PHP compiled with Open SSL to connect to IMAPS and to use the spell checker
 * A MySQL or PostgreSQL database engine or the SQLite extension for PHP
 * A database with permission to create tables
 
@@ -40,9 +49,9 @@ importing the table layout and granting the proper permissions to the
 roundcube user. Here is an example of that procedure:
 
 # mysql
-> CREATE DATABASE 'roundcubemail';
+> CREATE DATABASE roundcubemail;
 > GRANT ALL PRIVILEGES ON roundcubemail.* TO roundcube@localhost
-        IDENTIFIED BY 'password';
+    IDENTIFIED BY 'password';
 > quit
 # mysql roundcubemail < SQL/mysql.initial.sql
 
@@ -53,13 +62,17 @@ For MySQL version 4.1 and up, it's recommended to create the database for
 RoundCube with utf-8 charset. Here's an example of the init procedure:
 
 # mysql
-> CREATE DATABASE 'roundcubemail' DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci;
+> CREATE DATABASE roundcubemail DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci;
 > GRANT ALL PRIVILEGES ON roundcubemail.* TO roundcube@localhost
-        IDENTIFIED BY 'password';
+    IDENTIFIED BY 'password';
 > quit
 
 # mysql roundcubemail < SQL/mysql5.initial.sql
 
+Note: 'password' is the master password for the roundcube user. It is strongly
+recommended you replace this with a more secure password. Please keep in
+mind: You need to specify this password later in 'config/db.inc.php'.
+
 
 * SQLite
 --------
@@ -99,9 +112,17 @@ CONFIGURATION
 Change the files in config/* according your to environment and your needs.
 Details about the config paramaters can be found in the config files.
 
+You can also modify the default .htaccess file. This is necessary to
+increase the allowed size of file attachments, for example:
+  php_value       upload_max_filesize     2M
+
+To enable the experimental HTML editor you need to set the config
+parameter 'enable_htmleditor' to true.
+
 
 UPGRADING
 =========
+
 If you already have a previous version of RoundCube installed,
 please refer to the instructions in UPGRADING guide.