INSTALL

   1 INTRODUCTION
   2 ============
   3
   4 This file describes the basic steps to install RoundCube Webmail on your
   5 web server. For additional information, please also consult the project's
   6 wiki page at http://trac.roundcube.net/wiki
   7
   8
   9 REQUIREMENTS
  10 ============
  11
  12 * The Apache or Lighttpd Webserver
  13 * .htaccess support allowing overrides for DirectoryIndex
  14 * PHP Version 5.2 or greater including
  15    - PCRE (perl compatible regular expression)
  16    - DOM (xml document object model)
  17    - Libiconv
  18    - Multibyte String (mbstring)
  19    - Mcrypt (supporting Triple DES)
  20    - Database driver for either MySQL, Postgres or SQLite
  21 * php.ini options:
  22    - error_reporting E_ALL & ~E_NOTICE (or lower)
  23    - memory_limit (increase as suitable to support large attachments)
  24    - file_uploads enabled (for attachment upload features)
  25    - session.auto_start disabled
  26    - zend.ze1_compatibility_mode disabled
  27 * The PEAR framework with the following packages installed
  28    - MDB2 (2.4.1)
  29    - Mail_Mime (1.5.2)
  30    - Net_SMTP (1.2.11)
  31 * PHP compiled with OpenSSL to connect to IMAPS and to use the spell checker
  32 * A MySQL or PostgreSQL database engine or the SQLite extension for PHP
  33 * One of the above databases with permission to create tables
  34 * An SMTP server or PHP configured for mail delivery
  35
  36
  37 INSTALLATION
  38 ============
  39
  40 1. Decompress and put this folder somewhere inside your document root
  41 2. Make sure that the following directories (and the files within)
  42    are writable by the webserver
  43    - /temp
  44    - /logs
  45 3. Create a new database and a database user for RoundCube (see DATABASE SETUP)
  46 4. Point your browser to http://url-to-roundcube/installer/
  47 5. Follow the instructions of the install script (or see MANUAL CONFINGURATION)
  48 6. After creating and testing the configuration, remove the installer directory
  49 7. Done!
  50
  51
  52 DATABASE SETUP
  53 ==============
  54
  55 * MySQL
  56 -------
  57 Setting up the mysql database can be done by creating an empty database,
  58 importing the table layout and granting the proper permissions to the
  59 roundcube user. Here is an example of that procedure:
  60
  61 # mysql
  62 > CREATE DATABASE roundcubemail;
  63 > GRANT ALL PRIVILEGES ON roundcubemail.* TO roundcube@localhost
  64     IDENTIFIED BY 'password';
  65 > quit
  66
  67 # mysql roundcubemail < SQL/mysql.initial.sql
  68
  69 Note 1: 'password' is the master password for the roundcube user. It is strongly
  70 recommended you replace this with a more secure password. Please keep in
  71 mind: You need to specify this password later in 'config/db.inc.php'.
  72
  73 Note 2: For MySQL version 4.1 and up, it's recommended to create the database for
  74 RoundCube with utf-8 charset.
  75
  76
  77 * SQLite
  78 --------
  79 Sqlite requires specifically php5 (sqlite in php4 currently doesn't
  80 work with roundcube), and you need sqlite 2 (preferably 2.8) to setup
  81 the sqlite db (sqlite 3.x also doesn't work at the moment). Here is
  82 an example how you can setup the sqlite.db for roundcube:
  83
  84 # sqlite -init SQL/sqlite.initial.sql sqlite.db
  85
  86 Make sure your configuration points to the sqlite.db file and that the
  87 webserver can write to the file and the directory containing the file.
  88
  89
  90 * PostgreSQL
  91 ------------
  92 To use RoundCube with PostgreSQL support you have to follow these
  93 simple steps, which have to be done as the postgres system user (or
  94 which ever is the database superuser):
  95
  96 $ createuser roundcube
  97 $ createdb -O roundcube roundcubemail
  98 $ psql roundcubemail
  99
 100 roundcubemail =# ALTER USER roundcube WITH PASSWORD 'the_new_password';
 101 roundcubemail =# \c - roundcube
 102 roundcubemail => \i SQL/postgres.initial.sql
 103
 104 All this has been tested with PostgreSQL 8.x and 7.4.x. Older
 105 versions don't have a -O option for the createdb, so if you are
 106 using that version you'll have to change ownership of the DB later.
 107
 108
 109 MANUAL CONFIGURATION
 110 ====================
 111
 112 First of all, rename the files config/*.inc.php.dist to config/*.inc.php.
 113 You can then change these files according to your environment and your needs.
 114 Details about the config parameters can be found in the config files.
 115 See http://trac.roundcube.net/wiki/Howto_Install for even more guidance.
 116
 117 You can also modify the default .htaccess file. This is necessary to
 118 increase the allowed size of file attachments, for example:
 119         php_value       upload_max_filesize     2M
 120
 121
 122 UPGRADING
 123 =========
 124
 125 If you already have a previous version of RoundCube installed,
 126 please refer to the instructions in UPGRADING guide.
 127
 128