Install roundcube

== Introduction ==

So you've read up on what !RoundCube is, and what it can do.  But of course, you can't really know if you like it or not, unless you install it and use it for yourself for a week or two.  This document will help guide you through a standard installation of Roundcube.

=== Install RoundCube with IIS and hMailServer ===

There's a nice [http://www.hmailserver.com/forum/viewtopic.php?t=5591 how-to] about the installation of !RoundCube on a Windows box with IIS6 and hMailServer. '''NOTE:''' Make sure you set temp_dir in main.inc.php to an absolute path as otherwise users may run into issues with attaching files to emails.

A Debian-specific step-by-step [http://blogs.ungrund.org/xio/2008/08/13/roundcube-on-debian-testing/ how-to] in russian language also exists.


== Installation ==

=== Get !RoundCube! ===

Well obviously we need to get Roundcube before we can use it.  The easiest way to get it is to visit [http://www.roundcube.net] and click on "Downloads" or just go to [http://roundcube.net/downloads].  Wait for it to download and then unzip (using !WinZip or !ZipGenius or {{{tar -xzf roundcubemail-0.1.tar.gz}}}) in the current directory.

=== Get it ready ===

Now that we've got our files, we can upload the whole directory to the webserver (using your favorite FTP program) in case you're not already working there.

!RoundCube needs to save some temp files and it also writes logs. Therefore make sure that the following directories (and the files within) are writable for the webserver:
 * `temp`
 * `logs`

=== Database Configuration ===

Next thing we need to do is decide what database backend we'll use. The most common is MySQL but others are PostgreSQL and SQLite. 
So once you decide, create a database with any name you want and grant privileges to a separate database user. It's recommended not to use an existing user or root.

With MySQL you can set up the database by issuing the following commands:
{{{
CREATE DATABASE roundcubemail;
GRANT ALL PRIVILEGES ON roundcubemail.* TO username@localhost IDENTIFIED BY 'password';
}}}
(of course you have to replace the database, username and password accordingly)

See the INSTALL file for information about setting up PostgreSQL or SQLite

If you are using MySQL, be sure to flush the users privileges when you add a new user or you will get a database connection error:
{{{
FLUSH PRIVILEGES;
}}}

=== Configuring !RoundCube ===

After uploading the files point your browser to http://url-to-roundcube/installer/ to start the install wizzard.
The first page shows some requirements and by clicking "START INSTALLATION" the installer checks your webserver if everythng is there. In case you see some red '''NOT OK''' messages, you need to install or enable something. Follow the links or find out more by searching the http://www.php.net website.

Once your webserver is ready to run !RoundCube you can start creating the config files on the next step. Click "NEXT" to get there.
Get through the form and change the settings according to your needs.  Don't forget to enter the database credentials within the "Database Setup" section.
All the config parameter are described with a few words. If you don't know that a setting means, find out more on the [wiki:Howto_Config] page or just trust the defaults.

When finished the configuration hit the "CREATE CONFIG" button at the bottom of the page. You now get two text boxes on top of your browser window. Copy the contents and put them into two files within the {{{config}}} directory of your !RoundCube installation. Name them {{{main.inc.php}}} and {{{db.inc.php}}} as stated above the text boxes.

Finally click "CONTINUE" and get to the last step of the install process. Now your configuration is being verified tested against your webserver.
Click the "Initialize database" button in you're requested to in order to create the necessary tables in your database.

If there are no red '''NOT OK''' messages, you can also try to send a mail in order to test the SMTP settings.

Last but not least you have to remove the whole installer directory from the webserver. If this remains active it can expose the configuration including passwords.

=== Protect your installation ===

Access through your webserver to at least the following directories should be denied:
 * `/config`
 * `/temp`
 * `/logs`

Roundcube use .htaccess files to protect this directories, be sure to allow override of the `Limit` directives to get them taken into account.

== Conclusion ==

This is a very basic setup to get you up and running with Roundcube in less than twenty minutes.  There are plenty of other options, and a lot more options to investigate. See [wiki:Howto_Config] or browse the [http://www.roundcubeforum.net forums] for other tricks and modifications, as well as support if you just can't get it working.

Have fun with your new Roundcube installation!!

== Troubleshooting ==

'''500 Internal Server Error'''::
This is a very common problem.  The likely cause is !AllowOverride Apache directive is in effect. Try to comment all the lines in .htaccess in the document root and then uncomment one line at a time to find which directives in .htaccess cause the error. If these directives protect some critical files from downloading, ask your hoster or administrator to give you more !AllowOverride rights or include the problem directives from .htaccess file into administrator maintained configuration file.

'''Using MySQL - Database Error | Failed Connection'''
Make sure your database connection string is correct. If you are using MySQL 4.1 or above, your client libraries may not support the new password encryption protocol:   http://dev.mysql.com/doc/refman/5.0/en/old-client.html

'''Other Issues'''
If you're still having trouble after following the steps above, check out the [http://roundcube.net/support support page] where you'll find information about our forum or the mailing list. We also answered some [wiki:FAQ Frequently Asked Questions] concerning !RoundCube.

[[Categorie:Roundcube]]