+INTRODUCTION
+============
+
+This file describes the basic steps to install RoundCube Webmail on your
+web server. For additional information, please also consult the project's
+wiki page at http://trac.roundcube.net/wiki
+
REQUIREMENTS
============
-* The Apache Webserver
+* The Apache or Lighttpd 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)
+ - Libiconv
+ - Multibyte String (mbstring)
+ - Mcrypt (supporting Triple DES)
+ - 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)
+ - session.auto_start needs to be off/0
+* The PEAR framework with the following packages installed
+ - MDB2
+ - 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
+* One of the above databases with permission to create tables
+* An SMTP server or PHP configured for mail delivery
INSTALLATION
- /temp
- /logs
3. Create a new database and a database user for RoundCube (see DATABASE SETUP)
-4. Create database tables using the queries in file 'SQL/*.initial.sql'
- (* stands for your database type)
-5. Rename the files config/*.inc.php.dist to config/*.inc.php
-6. Modify the files in config/* to suit your local environment
+4. Point your browser to http://url-to-roundcube/installer/
+5. Follow the instructions of the install script (or see MANUAL CONFINGURATION)
+6. After creating and testing the configuration, remove the installer directory
7. Done!
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
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
--------
# sqlite -init SQL/sqlite.initial.sql sqlite.db
Make sure your configuration points to the sqlite.db file and that the
-webserver can write to the file.
+webserver can write to the file and the directory containing the file.
* PostgreSQL
------------
-To use RoundCube with PostgreSQL support you have to follow the next
-simple steps, which have to be done with the postgres system user (or
+To use RoundCube with PostgreSQL support you have to follow these
+simple steps, which have to be done as the postgres system user (or
which ever is the database superuser):
-$ createuser roundcubemail
-$ createdb -O roundcubemail roundcubemail
+$ createuser roundcube
+$ createdb -O roundcube roundcubemail
$ psql roundcubemail
roundcubemail =# ALTER USER roundcube WITH PASSWORD 'the_new_password';
-roundcubemail =# \c - roundcubemail
+roundcubemail =# \c - roundcube
roundcubemail => \i SQL/postgres.initial.sql
-All this has been tested with PostgreSQL 8.0.x and 7.4.x. Older
+All this has been tested with PostgreSQL 8.x and 7.4.x. Older
versions don't have a -O option for the createdb, so if you are
using that version you'll have to change ownership of the DB later.
-CONFIGURATION
-=============
+MANUAL CONFIGURATION
+====================
+
+First of all, rename the files config/*.inc.php.dist to config/*.inc.php.
+You can then change these files according to your environment and your needs.
+Details about the config parameters can be found in the config files.
+See http://trac.roundcube.net/wiki/Howto_Install for even more guidance.
-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
UPGRADING
=========
+
If you already have a previous version of RoundCube installed,
please refer to the instructions in UPGRADING guide.
projects / roundcube.git / blobdiff