INSTALL

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