Plugins Installation – Installing & Registering Plugins
How to register a plugin in Roundcube WebmailBefore attempting to register plugins in Roundcube Webmail, you should pay close attention to the specifics of the plugin in question. For example, plugins such as calendar, sticky_notes and many others require you to add or modify tables in the roundcube’s database you are working with. Irrespective the source of your plugin, chances are that the developer has included important documentation and requirements you should read before attempting to use such plugin.
Please, do so. Take a few moments to read and get familiar with the plugin you will be working with even if you have no PHP knowledge. It will save you a lot of time and most likely you will effectively configure, register and use those plugins without going into any bumps or opss!
Once you have a general idea of the plugin you are working with, it is time not to register it but to configure it. Hence, you want to keep reading below.
- To configure a plugin, make a copy of its config.inc.php.dist file in its same directory and rename the new file to config.inc.php
- You should now have a new file in your plugin’s folder ./plugins/plugin_sample1/config.inc.php
- Leave the config.inc.php.dist file in the plugin directory. Do not remove or rename this file.
- Open the new config.inc.php file and edit settings according to your needs.
Requirements & Dependencies
Bravo! Now we know and have a basic understanding of how to configure a plugin. It is time to register my plugin next because I have already configured it! So how do I proceed? …keep on reading.
To register a plugin you have previously configured, browse to …/config/main.inc.php. Find the following section in that configuration file:
... // List of active plugins (in plugins/ directory) $rcmail_config['plugins'] = array(); ...
This is the default configuration for your Roundcube Webmail plugins. Within this array you register plugins in your Roundcube installation. To enable(register) plugin_sample1 and plugin_sample2 simply add them to your configuration as follow:
... // List of active plugins (in plugins/ directory) $rcmail_config['plugins'] = array('plugin_sample1', 'plugin_sample2'); ...
Congratulations! You have now configured and registered your plugins. Time for testing… browse to your Roundcube Webmail installation and explore its new features. Have fun.