Installation Instructions (manual)

Horst Fickel edited this page Aug 30, 2013 · 3 revisions

Assuming you have already installed Roundcube and ISPConfig 3, follow the instructions below. If not, please download and install Roundcube from http://www.roundcube.net/ and ISPConfig 3 from http://www.ispconfig.org/.

Step 1

Make sure you are using the latest stable ISPconfig. (Currently 3.0.5.2)
Make sure you are using the latest stable Roundcube. (Currently 0.9)
Read the Requirements document: Requirements

Step 2

Go to your ISPconfig panel and add a new remote user. (Tab "servers" > "Remote users")

Tick

  • Client functions
  • Server functions
  • Mail user functions
  • Mail alias functions
  • Mail fetchmail functions
  • Mail user filter functions
  • Mail spamfilter user functions
  • Mail spamfilter policy functions
  • Mail spamfilter whitelist functions
  • Mail spamfilter blacklist functions

Step 3

Now download the latest ispconfig3-plugin package for roundcube.

install per SVN

Make sure you're in your Roundcube root directory.

cd plugins

Don't forget the "." (period) at the end of the second command, or it could be creating a directory called "/trunk/". Obviously, this is not what we want.

svn co https://github.com/w2c/ispconfig3_roundcube/trunk/ .

update per SVN

Make sure you're in your Roundcube root directory.

cd plugins

Don't forget the "." (period) at the end of the second command, or it could be creating a directory called "/trunk/". Obviously, this is not what we want.

svn up .

install per archive

Download the newest archive from

https://github.com/w2c/ispconfig3_roundcube/archive/master.zip

Extract the plugin folders in the zip file, to your Roundcube root directory/plugins folder

Step 4

Copy the file "./ispconfig3_account/config/config.inc.php.dist" to "./ispconfig3_account/config/config.inc.php".

Step 5

In the configfile of the "ispconfig3_account" (/plugins/ispconfig3_account/config/config.inc.php) fill in your details:

$rcmail_config['remote_soap_user'] = '{REMOTE USERNAME}';
$rcmail_config['remote_soap_pass'] = '{REMOTE PASSWORD}';
$rcmail_config['soap_url'] = 'http://{YOUR SERVER}:8080/remote/';

Change the port (set to "8080" by default) if necessary and please note that when using SSL to access ISPconfig panel, use "https://" instead of "http://".

For example, if your username is "Santa", your password is "Claus", your server's domain is "christmas.com" (Or you can use an IP), your ISPconfig panel is accessed through port 1111, and you are not using SSL, your configuration would be:

$rcmail_config['remote_soap_user'] = 'Santa';
$rcmail_config['remote_soap_pass'] = 'Claus';
$rcmail_config['soap_url'] = 'http://christmas.com:1111/remote/';

Step 6

!! If you are just using one server for mail, don't use the autoselect plugin !!

In the configfile of roundcube (/config/main.inc.php) look for this:

// List of active plugins (in plugins/ directory)
$rcmail_config['plugins'] = array();

If other plugins are already enabled, add the following plugins to the array:

, "jqueryui", "ispconfig3_account", "ispconfig3_autoreply", "ispconfig3_autoselect", "ispconfig3_pass", "ispconfig3_spam", "ispconfig3_fetchmail", "ispconfig3_filter", "ispconfig3_forward", "ispconfig3_wblist"

!! The jqueryui plugin has to be before the ISPConfig 3 plugins in the array !!

Otherwise, replace it with the following:

// List of active plugins (in plugins/ directory)
$rcmail_config['plugins'] = array("jqueryui","ispconfig3_account", "ispconfig3_autoreply", "ispconfig3_autoselect", "ispconfig3_pass", "ispconfig3_spam", "ispconfig3_fetchmail", "ispconfig3_filter", "ispconfig3_forward", "ispconfig3_wblist");

Any plugins that you want disabled, are to be removed from this line. For instance, if you do not wish to have "ispconfig3_pass" (password changer) enabled, you have to remove it from the list. It would then look like this:

// List of active plugins (in plugins/ directory)
$rcmail_config['plugins'] = array("jqueryui", "ispconfig3_account", "ispconfig3_autoreply", "ispconfig3_autoselect", "ispconfig3_spam", "ispconfig3_fetchmail", "ispconfig3_filter", "ispconfig3_forward", "ispconfig3_wblist");

Step 7

A new tab ("Accounts") should now be visible on your settings page in Roundcube, displaying all plugins enabled in step 6.

Good luck! ;)

PS: If you encounter any issue, look here document: Troubleshooting / FAQ

Step 8 (Optional, but higly recommended)

For security reasons it is important to export the plugin-files of the subversion or delete the .svn folders after the checkout. Otherwise, these directories are accessible (when using incorrect permissions). Attackers can gain information about internal structures (e.g. /webmail/plugins/.svn/entries). Another way to circumvent this problem is setting an Apache Directive. e.g.:

<DirectoryMatch \.svn>    
  Order allow,deny
  Deny from all
</DirectoryMatch>
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.