34
edits
Changes
From SME Server
Jump to navigationJump to searchno edit summary
===Installation===
===Installation===
==== '''For SME8''' ====
==== '''For SME9''' ====
Remember to first configure the two required repositories, [[stephdl]] and [[epel]],
Remember to first configure the required [[stephdl]] repository, then issue the following command on the SME Server shell:
then issue the following command on the SME Server shell:
yum install smeserver-roundcube --enablerepo=epel,stephdl
yum install smeserver-roundcube --enablerepo=stephdl
rcplugin_update.sh
rcplugin_update.sh
signal-event post-upgrade; signal-event reboot
signal-event post-upgrade; signal-event reboot
==== '''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
yum install smeserver-roundcube --enablerepo=stephdl
rcplugin_update.sh
rcplugin_update.sh
or
or
signal-event post-upgrade; signal-event reboot
signal-event post-upgrade; signal-event reboot
===Uninstallation===
===Uninstallation===
The smeserver-roundcube contrib is shipped with the following plugins already installed and enabled by default:
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,markasjunk2,vcard_attachments,newmail_notifier,emoticons,tasklist,managesieve
''globaladdressbook,carddav,calendar,libcalendaring,contextmenu,markasjunk2,vcard_attachments,newmail_notifier,emoticons,tasklist,managesieve''
=====Adding additional plugins=====
=====Adding additional plugins=====
'''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!
'''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!
nano /opt/roundcube/composer.json
"require": {
"require": {
'''Step 4:''' after each modification to composer.json, in order to automatically download and install the plugin launch
'''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.
When asked, answer yes to automatically activate the plugin in the current Roundcube configuration.
'''Step 5a:''' First show the list of plugins currently in the configuration DB:
'''Step 5a:''' First show the list of plugins currently in the configuration DB:
config getprop roundcube PluginsList
''PluginsList=globaladdressbook,carddav,calendar,libcalendaring,contextmenu,markasjunk2,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:
'''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:
'''Step 5c:''' Activate the changes to the config DB:
signal-event conf-roundcube
Step 5 in short, using backticks:
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:
To check for updates to plugins already installed, you can at any time issue the following command again:
rcplugin_update.sh
====Customize Roundcube settings====
====Customize Roundcube settings====
* The config file for Roundcube itself is now templated, so changes need to be made in a new custom template fragment
* The config file for Roundcube itself is now templated, so changes need to be made in a new custom template fragment
ll /etc/e-smith/templates/opt/roundcube/config/config.inc.php/
10default_host 15Ldap_addressbook 20plugins_configuration template-begin template-end
''10default_host 15Ldap_addressbook 20plugins_configuration template-begin template-end ''
* check which setting you want to change with
* check which setting you want to change with
cat /opt/roundcube/config/defaults.inc.php
* Extend the default settings by adding a new template fragment and add your customizations/additions there, eg.:
* Extend the default settings by adding a new template fragment and add your customizations/additions there, eg.:
vim /etc/e-smith/templates/opt/roundcube/config/config.inc.php/30my_custom_settings
* Finally, expand the template:
* Finally, expand the template:
signal-event conf-roundcube
Likewise, plugin customization can be done by creating custom template fragments.
Likewise, plugin customization can be done by creating custom template fragments.
* check the current configuration of the managesieve plugin:
* check the current configuration of the managesieve plugin:
cat /opt/roundcube/plugins/managesieve/config.inc.php
* check current template fragments for the plugin configuration:
* check current template fragments for the plugin configuration:
ll /etc/e-smith/templates/opt/roundcube/plugins/managesieve/config.inc.php/
...
-rw-r--r-- 1 root root 266 30. Nov 19:45 30showvacation
''...''
...
''-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:
* copy the relevant template fragment to /etc/e-smith/templates-custom/... and modify the setting:
mkdir -p /etc/e-smith/templates-custom/opt/roundcube/plugins/managesieve/config.inc.php
cp /etc/e-smith/templates/opt/roundcube/plugins/managesieve/config.inc.php/30showvacation /etc/e-smith/templates-custom/opt/roundcube/plugins/managesieve/config.inc.php/
vim /etc/e-smith/templates-custom/opt/roundcube/plugins/managesieve/config.inc.php/30showvacation
* Finally, expand the customized template:
* Finally, expand the customized template:
signal-event conf-roundcube
{{Note box|If you think your setting should be the SME default raise a bug}}
{{Note box|If you think your setting should be the SME default raise a bug}}
{{note box|this adds another url, it doesn't remove the default}}
{{note box|this adds another url, it doesn't remove the default}}
config setprop roundcube URL webmail
or
or
config setprop roundcube URL mail
To enable your changes run these commands
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
*If you want to remove completely the new url
config delprop roundcube URL
then
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 [[Dovecot-extras|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 (as [[#Adding additional plugins|described above]] in Step 5 ff., remove <tt>managesieve</tt> from the list of installed plugins).
=====Troubleshooting=====
* If mails are not correctly filtered by the filters configured in user's roundcube settings, check the following:
** Is [[Dovecot-extras|smeserver-dovecot-extras]] installed and is the sieve service enabled ( <tt># config getprop sieve status</tt> => enabled )? If it is not enabled: <tt># config setprop sieve status enabled</tt>
** Is using sieve deliberately disabled for the user in question ( <tt>db accounts getprop $USER Sieve</tt> => disabled )? If it is disabled: <tt># db accounts setprop $USER Sieve enabled</tt> (Note the capital "S" in Sieve!)
** If [[Mailsorting|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.
------------------
==RoundCube V0.9.5 for SME Server==
==RoundCube V0.9.5 for SME Server==
{{note box|RoundCube version 0.95beta is possibly deprecated. SME admins are encouraged to use the stable version 1.0 described above instead.}}
{{note box|RoundCube version 0.95beta is possibly deprecated. SME admins are encouraged to use the stable version 1.0 described above instead. This section is left more or less for reference.}}
===Maintainer===
===Maintainer===
[mailto:stephdl@de-labrusse.fr stephdl] Stéphane de Labrusse AKA [[User:stephdl|Stephdl]]<br />
[mailto:stephdl@de-labrusse.fr stephdl] Stéphane de Labrusse AKA [[User:stephdl|Stephdl]]<br />
* The config file is now templated, so changes need to be made in a new fragment
* The config file is now templated, so changes need to be made in a new fragment
ll /etc/e-smith/templates/opt/roundcube/config/config.inc.php/
10default_host 15Ldap_addressbook 20plugins_configuration template-begin template-end
10default_host 15Ldap_addressbook 20plugins_configuration template-begin template-end
