RoundCube

	Skill level: Easy
	The instructions for installing and using Roundcube can be followed by a beginner, changing options requires a basic knowledge of linux.

Is this article helpful to you?
Please consider donating or volunteering
Thank you!

RoundCube V1.0 for SME Server

Maintainer

stephdl Stéphane de Labrusse AKA Stephdl

Versions

Contrib 10:

1.2-24

Contrib 9:

1.2-9

smeserver-roundcube

The latest version of smeserver-roundcube is available in the SME repository, click on the version number(s) for more information.

roundcubemail_plugins is deprecated in SME10, all is provided by smeserver-roundcube

Release	Released	Active Support	Security Support	Latest
1.6	25 Jul 2022	Yes	Yes	1.6.0
1.5 LTS	18 Oct 2021	Yes	Yes	1.5.3

Installation

For SME 10For SME 9For SME 8

yum install smeserver-extrarepositories-remi-roundcube -y

for the LTS version 1.5.3 add this

yum install yum-plugin-versionlock -y
yum versionlock  add roundcubemail-1.5.3

otherwise you will update to 1.6

yum install smeserver-roundcube   --enablerepo=smecontribs,remi-roundcube

to revert versionlock

yum versionlock delete roundcubemail
yum update
/usr/bin/rcplugin_update.sh
signal-event smeserver-roundcube-update

yum install smeserver-roundcube --enablerepo=smecontribs

answer yes (y) for all plugins you want to activate

If you do not want to restart your server

signal-event roundcube-update

or

signal-event post-upgrade; signal-event reboot

upgrade

yum upgrade --enablerepo=smecontribs,remi-roundcube

For SME8

Remember to first configure the two required repositories, stephdl and epel, then issue the following command on the SME Server shell:

yum install smeserver-roundcube --enablerepo=epel,stephdl
rcplugin_update.sh

answer yes (y) for all plugins you want to activate

If you do not want to restart your server

signal-event roundcube-update

or

signal-event post-upgrade; signal-event reboot

Uninstallation

To remove the package issue the following command on the SME Server shell:

yum remove roundcube smeserver-roundcube smeserver-roundcube_plugins

To remove mysql database and user, both are roundcube, see MySQL#Remove a database and MySQL#Remove a user. There is no need to reboot.

Usage

http://servername/roundcube and logon with your SME Server user account.

Logs

Logs are available :

• for sme8

less /opt/roundcube/logs/errors

• for sme9 and after

less /var/log/roundcubemail/errors

	Note:
	Roundcube will connect to IMAP with SSL to the primary domain of your server. You need a valid or a self-signed certificate including your own domain name at least as alternative DNS.

Limit access to web interface

	Note:
	By default, the Roundcube webmail interface is accessible from the entire internet without requiring additional HTTP authentication.

Access to Roundcube can be fine-tuned by setting the corresponding property in the configuration DB of SME server:

config setprop roundcube PublicAccess OPTION

where OPTION is either of the following:

       none             => No access
       local            => Local network   (no password required)
       local-pw         => Local network   (password required)
       global           => Entire Internet (no password required, this is the default on SME)
       global-pw        => Entire Internet (password required)
       global-pw-remote => Entire Internet (password required outside local network)

For example, to restrict access to LAN only:

config setprop roundcube PublicAccess local

To activate these changes to the configuration DB, run these commands:

expand-template /etc/httpd/conf/httpd.conf
sv h /service/httpd-e-smith

afterwards.

Note: for a general description of how DB settings work on SME server, have a look at Web Application RPM#New DB settings.

Customization

Roundcube plugins

Default plugins shipped with smeserver-roundcube

The smeserver-roundcube contrib is shipped with the following plugins already installed and enabled by default:

config getprop roundcube PluginsList

globaladdressbook,carddav,calendar,libcalendaring,contextmenu,markasjunk,vcard_attachments,newmail_notifier,emoticons,tasklist,managesieve

Installing additional plugins

	Note:
	The upstream Roundcube project is currently transitioning from making plugins available through http://trac.roundcube.net/wiki/Plugin_Repository to a new full fledged plugin repository at http://plugins.roundcube.net and a semi-automated plugin installation process. SME server admins are encouraged to use the new style method described below.

To install an additional (non-default) Roundcube plugin in SME server roundcube :

Step 1: Find the plugin page on http://plugins.roundcube.net/packages (eg. http://plugins.roundcube.net/packages/cor/message_highlight)

Step 2: Take note of the package name and version shown in the 'require:' line right below the title of the plugin's version heading (eg. "cor/message_highlight": "dev-master")

Step 3: Add the package name and version to the "require:" block in /opt/roundcube/composer.json. Take attention to the comma (,) separator, it is really important!

For SME 10For SME 9For SME 8

cd /usr/share/roundcubemail
/usr/bin/php74  /usr/local/bin/composer require cor/message_highlight --with-dependencies

nano /usr/share/roundcubemail/composer.json

 "require": {
      	"php": ">=5.3.0",
      	"roundcube/plugin-installer": ">=0.1.3",
      	"johndoh/markasjunk2": "dev-release-1.0",
      	"johndoh/contextmenu": "dev-master",
      	"johndoh/globaladdressbook": "dev-release-1.0",
        "cor/message_highlight": "dev-master"
    },

nano /opt/roundcube/composer.json

 "require": {
      	"php": ">=5.3.0",
      	"roundcube/plugin-installer": ">=0.1.3",
      	"johndoh/markasjunk2": "dev-release-1.0",
      	"johndoh/contextmenu": "dev-master",
      	"johndoh/globaladdressbook": "dev-release-1.0",
        "cor/message_highlight": "dev-master"
    },

Step 4: after each modification to composer.json, in order to automatically download and install the plugin launch

rcplugin_update.sh

When asked, answer yes to automatically activate the plugin in the current Roundcube configuration.

Step 5: In order to keep the list of installed plugins persistent when this contrib is updated (ie. configuration templates are expanded again), you *absolutely* need to add the newly installed Roundcube plugin to the "PluginsList" property of "roundcube" in the configuration database of SME server in addition to steps above:

Step 5a: First show the list of plugins currently in the configuration DB:

config getprop roundcube PluginsList

PluginsList=globaladdressbook,carddav,calendar,libcalendaring,contextmenu,markasjunk,vcard_attachments,newmail_notifier,emoticons,tasklist,managesieve

Step 5b: Add your newly installed plugin to the list (separated by a comma (,) and without spaces) and activate the change:

config setprop roundcube PluginsList globaladdressbook,carddav,calendar,libcalendaring,contextmenu,markasjunk2,vcard_attachments,newmail_notifier,emoticons,tasklist,managesieve,message_highlight

Step 5c: Activate the changes to the config DB:

signal-event roundcube-update

Step 5 in short, using backticks:

config setprop roundcube PluginsList `config getprop roundcube PluginsList`,message_highlight
signal-event conf-roundcube

To check for updates to plugins already installed, you can at any time issue the following command again:

rcplugin_update.sh

Customize Roundcube settings

For special needs you should create your personal template file if you want your config file will not be overwritten by the smeserver-roundcube templates. This also applies to Roundcube plugins in /opt/roundcube/plugins/ which occasionally come with their own config.inc.php or generic config.php.inc.dist which you can use to set default options.

• The config file for Roundcube itself is now templated, so changes need to be made in a new custom template fragment

• for sme8

ll /etc/e-smith/templates/opt/roundcube/config/config.inc.php/

10default_host           15Ldap_addressbook       20plugins_configuration  template-begin           template-end             

• for sme9/sme10

ls /etc/e-smith/templates/etc/roundcubemail/config.inc.php/
10SQL_DATABASE  20LOGGING_DEBUGGING  30IMAP  40SMTP  50LDAP  60SYSTEM  70USER_INTERFACE  80ADDRESSBOOKS_SETTINGS  90USER_PREFERENCES  95PLUGINS  template-begin  template-end

• check which setting you want to change with

cat /etc/roundcubemail/defaults.inc.php

• Extend the default settings by adding a new template fragment and add your customizations/additions there, eg.:

vim /etc/e-smith/templates/etc/roundcubemail/config/config.inc.php/30my_custom_settings

• Finally, expand the template:

signal-event roundcube-update

Likewise, plugin customization can be done by creating custom template fragments. For example, to set if and how the "vacation management panel" of the "managesieve" plugin should appear in the Roundcube webmail frontend:

• check the current configuration of the managesieve plugin:

cat /usr/share/roundcubemail/plugins/managesieve/config.inc.php

• check current template fragments for the plugin configuration:

ll /etc/e-smith/templates/usr/share/roundcubemail/plugins/managesieve/config.inc.php/
 
 ...
 -rw-r--r-- 1 root root  266 30. Nov 19:45 30showvacation
 ...

• copy the relevant template fragment to /etc/e-smith/templates-custom/... and modify the setting:

mkdir -p /etc/e-smith/templates-custom/usr/share/roundcubemail/plugins/managesieve/config.inc.php
 
cp /etc/e-smith/templates/usr/share/roundcubemail/plugins/managesieve/config.inc.php/30showvacation /etc/e-smith/templates-custom/usr/share/roundcubemail/plugins/managesieve/config.inc.php/

vim /etc/e-smith/templates-custom/usr/share/roundcubemail/plugins/managesieve/config.inc.php/30showvacation

• Finally, expand the customized template:

signal-event roundcube-update

	Note:
	If you think your setting should be the SME default raise a bug

Add an alternative URL

If Roundcube should be reachable by an alternative URL to http://yourserver.net/roundcube, eg.

http://yourserver.net/webmail 

or

http://yourserver.net/mail

	Warning:
	The URL /webmail is by default used by the horde webmail, so you have to deactivate the webmail in the server-manager's "Configuration" -> "Email" panel if you want to use it for roundcube instead.

	Note:
	this adds another url, it doesn't remove the default

config setprop roundcube URL webmail

or

config setprop roundcube URL mail

To enable your changes run these commands

expand-template /etc/httpd/conf/httpd.conf
sv h /service/httpd-e-smith

• If you want to remove completely the new url

config delprop roundcube URL

then

expand-template /etc/httpd/conf/httpd.conf
sv h /service/httpd-e-smith

Miscellaneous notes

Mail filter support (Sieve)

Roundcube V1.0 on SME server comes with the managesieve plugin installed and enabled by default. The managesieve plugin adds additional menu items to the settings in Roundcube's webinterface to allow users to define mail filters and vacation messages in a convenient way. However, to make use of these features, the smeserver-dovecot-extras contrib also has to be installed (this adds sieve script support and a manage sieve daemon to SME server). If these features are not wanted, Roundcube's managesieve plugin should be disabled (reverse Step 5 described above, ie. remove managesieve from the list of installed plugins).

	Warning:
	sieverules has been deprecated and you must only use managesieve

Troubleshooting

• If mails are not correctly filtered by the filters configured in user's roundcube settings, check the following:
  • Is smeserver-dovecot-extras installed and is the sieve service enabled ( config getprop sieve status => enabled )? If it is not enabled: config setprop sieve status enabled
  • Is using sieve deliberately disabled for the user in question ( db accounts getprop $USER Sieve => disabled )? If it is disabled: db accounts setprop $USER Sieve enabled (Note the capital "S" in Sieve!)
  • If smeserver-mailsorting is also installed on the server, mails are first filtered by procmail or maildrop before they are handed off to the dovecot delivery agent and sieve filters. Chances are that a rule exists in a user's .procmailrc or .mailfilter file that intercepts all mails before they get to the latter stage in the mail delivery process.

---

Bugs

Please raise bugs under the SME-Contribs section in bugzilla and select the smeserver-roundcube component or use this link .

• smeserver-roundcube

ID	Product	Version	Status	Summary (2 tasks) ⇒
12587	SME Contribs	10.0	CONFIRMED	composer installs skins in plugins folder
12270	SME Contribs	10.0	CONFIRMED	NFR: Allow the specification of the host for the imap mail

• roundcubemail_plugins

"No open bugs found."