Roundcube Plus Help Desk

Knowledgebase
Search help:

How do I install a plugin?

This article describes the steps you need to take to install a Roundcube plugin. Keep in mind that some plugins will require additional setup steps that will be listed in the plugin's README file. Please refer to that file for detailed instructions.

1. Copy the plugin files the Roundcube's plugins directory.

First you should find the directory where your Roundcube is installed. If you're installing under cPanel, click here for instructions.

Roundcube Plus plugins come in compressed tar.gz packages. Extract the contents of the package into Roundcube's 'plugins' directory. Don't forget to copy the xframework folder; our plugins won't work without it.

2. Configure the plugin.

Nearly every one of our plugins comes with its own configuration file located in the plugin's directory. Initially this configuration file is called config.inc.php.dist. You need to rename it to config.inc.php.

Now edit the file config.inc.php and check if any of the options require modification. Follow the instructions provided in the file itself and in the plugin's README file.

3. Add the plugin to Roundcube's config.

Now that the plugin is copied and configured, you need to let Roundcube know that it should be loaded. To do this, you need to add the plugin's name to the Roundcube's main config file.

a) Edit the file [roundcube]/config/config.inc.php.

b) Find the line that reads:

$config['plugins'] = array();

c) Add the name of the plugin to the array enclosing it in single quotes. For example, if you're installing the xcalendar plugin:

$config['plugins'] = array('xcalendar');

If you already have some plugins in the array, you should add the name of your new plugin at the end of the list. For example, if you're running Roundcube under cPanel, your plugins array might look like this:

$config['plugins'] = array('cpanellogin', 'cpanellogout');

This is the proper way to add another plugin:

$config['plugins'] = array('cpanellogin', 'cpanellogout', 'xcalendar');

A common mistake is adding a second $config['plugins'] line below the first one. For example, this will NOT work properly:

$config['plugins'] = array('cpanellogin', 'cpanellogout');
$config['plugins'] = array('xcalendar');

You should only have one $config['plugins'] line, with all your plugins listed inside the array() statement, quoted and separated with commas.

Do not add xframework to the plugins array; it's not necessary.

4. Add the license key.

Our plugins require you to add a license key to the Roundcube config file. You can find this key in the download section of our website's customer area.

The license key needs to be added to the file [roundcube]/config/config.inc.php, the same file that you edited a moment ago to add the plugin to the plugins array.

Scroll down to the end of the file and add the following line:

$config['license_key'] = 'your-license-key-here';

Replace 'your-license-key-here' with your actual license key.

Congratulations! Your plugin is now installed! Roundcube will load your new plugin after you refresh your browser.

Was this article helpful? yes / no