Home / How To / Install ISPConfig 3 – Roundcube plugins on Debian 10

Install ISPConfig 3 – Roundcube plugins on Debian 10



The ispconfig3_roundcube plugins integrate your ISPConfig mail settings into Roundcube. In this tutorial I will walk you through the process of installing them.

Conditions

  • Roundcube must be installed with apt. If not, you may need to change the file paths used in this tutorial.
  • Make sure your ISPConfig and Roundcube installation is up to date

Add a remote user

ISPConfig 3 plugins use the API to connect to your system. Therefore, we need to create a remote user in the control panel.

Log in to your panel, go to System -> Remote users and click on “Add new remote user”. In the form, give your new user a name and password. I’m going to use rc example with the password example pass. Do not use the same references but create your own. My sample panel is available at https://panel.example.com:8080 with a valid SSL certificate

Enable the following features for your remote user:

  • Client features
  • Server functions
  • Email user features
  • Email user filter features
  • Email aliasing features
  • Email forwarding features
  • Email retrieval features
  • Email spam filter user features
  • Email Spam Filter Features
  • Email spam filter whitelist features
  • Spam filter blacklist features

And enable remote access for the IPv4 and IPv6 address of your webmail server.

Download plugins

Run the following commands:

cd /tmp
wget https://github.com/w2c/ispconfig3_roundcube/archive/master.zip
unzip master.zip
cd ./ispconfig3_roundcube-master
cp -r ./ispconfig3_* /usr/share/roundcube/plugins
ln -s /usr/share/roundcube/plugins/ispconfig* /var/lib/roundcube/plugins/

Plugins are now in the correct folder with a symlink from / var / lib / roundcube / plugins. The next step is to configure them to use our remote user. Run this to copy the sample configuration and edit it:

cp /usr/share/roundcube/plugins/ispconfig3_account/config/config.inc.php.dist /usr/share/roundcube/plugins/ispconfig3_account/config/config.inc.php
nano /usr/share/roundcube/plugins/ispconfig3_account/config/config.inc.php

You will see this configuration file:

$config['identity_limit'] = false;
$config['remote_soap_user'] = '{REMOTE USERNAME}';
$config['remote_soap_pass'] = '{REMOTE PASSWORD}';
$config['soap_url'] = 'https://{YOUR SERVER}:8080/remote/';
$config['soap_validate_cert'] = true;

I change this to:

$config['identity_limit'] = false;
$config['remote_soap_user'] = 'rc-example';
$config['remote_soap_pass'] = 'examplepass';
$config['soap_url'] = 'https://panel.example.com:8080/remote/';
$config['soap_validate_cert'] = true;

Be sure to replace the red underlined text with your own references and panel address. Change soap_validate_cert to false if you are using https but do not have a trusted SSL certificate installed.

Enable plugins

To activate the plugins, open the configuration for the round cube:

nano /etc/roundcube/config.inc.php

And search for these lines:

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

To activate plugins, add this in parentheses:

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

The line then looks like this:

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

Some notes on this:

  • Plugin for jqueryui must be placed in front of other plugins.
  • If you do not want to use a plugin, such as the fetchmail plugin, leave ispconfig3_fetchmail.
  • If you use more than one mail server, add ispconfig3_autoselect to the list and leave $config['default_host'] empty. ispconfig3_autoselect automatically selects the correct server for the user logging in. You can edit your own configuration file to enable tls / ssl connections between Roundcube and the remote mail server in ispconfig3_autoselect / config / config.inc.php.dist

After saving the configuration file, a new “Account” tab will appear in the webmail settings:

New tab for settings

Was done!

If you have any issues you can check out the troubleshooting FAQ at https://github.com/w2c/ispconfig3_roundcube/wiki/Troubleshooting—FAQ

If you have any questions or comments, you can leave them in the answers or create a forum post.


Source link