Line 6: |
Line 6: |
| ==RoundCube V1.0 for SME Server== | | ==RoundCube V1.0 for SME Server== |
| ===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]] |
| + | |
| + | == Versions == |
| {{ #smeversion: smeserver-roundcube }} | | {{ #smeversion: smeserver-roundcube }} |
− | {{ #smeversion: roundcubemail_plugins }}
| |
− | {{ #smeversion: roundcubemail }}
| |
− | {{ #smeversion: roundcube }}
| |
| | | |
− | ===Installation===
| |
− | <tabs container><tab name="For SME 10">
| |
− | This needs a revamp
| |
| | | |
− | We can use the Remi repo for Roundcube itself
| + | roundcubemail_plugins is deprecated in SME10, all is provided by smeserver-roundcube |
| + | {| class="wikitable" |
| + | !Release |
| + | !Released |
| + | !Active Support |
| + | !Security Support |
| + | !Latest |
| + | |- |
| + | |1.6 |
| + | |25 Jul 2022 |
| + | |Yes |
| + | |Yes |
| + | |1.6.5 |
| + | |- |
| + | |1.5 LTS |
| + | |18 Oct 2021 |
| + | |Yes |
| + | |Yes |
| + | |1.5.6 |
| + | |} |
| | | |
− | https://wiki.contribs.org/Remi-roundcube
| + | ===Installation=== |
− | | + | <tabs container=""><tab name="For SME 10"> |
− | It will need the smeserver-roundcube plugin rewriting for php-fpm
| + | yum install smeserver-extrarepositories-remi-roundcube -y |
| + | we now only support version 1.6.x |
| + | yum install smeserver-roundcube --enablerepo=smecontribs,remi-roundcube |
| | | |
| + | if you previously locked to version 1.5, to revert versionlock<syntaxhighlight lang="bash"> |
| + | yum versionlock delete roundcubemail |
| + | yum update -y |
| + | signal-event smeserver-roundcube-update |
| + | </syntaxhighlight> |
| | | |
| </tab><tab name="For SME 9"> | | </tab><tab name="For SME 9"> |
Line 50: |
Line 72: |
| signal-event post-upgrade; signal-event reboot | | signal-event post-upgrade; signal-event reboot |
| </tab> | | </tab> |
| + | </tabs> |
| | | |
| ===Uninstallation=== | | ===Uninstallation=== |
Line 60: |
Line 83: |
| http://servername/roundcube'' and logon with your SME Server user account. | | http://servername/roundcube'' and logon with your SME Server user account. |
| | | |
| + | {{Note box|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.}} |
| ===Logs=== | | ===Logs=== |
− | Logs are available :
| + | <tabs container=""><tab name="For SME 9 and newer"> |
− | * for sme8
| + | less /var/log/roundcubemail/errors |
| + | </tab><tab name="For SME 8"> |
| less /opt/roundcube/logs/errors | | less /opt/roundcube/logs/errors |
− | * for sme9
| + | </tab></tabs> |
− | less /var/log/roundcubemail/errors
| |
| | | |
| ===Limit access to web interface=== | | ===Limit access to web interface=== |
− | {{Note box|By default, the Roundcube webmail interface is accessible from the entire internet without requiring additional HTTP authentication. }} | + | {{Note box|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: |
| + | <tabs container=""><tab name="For SME 10 smeserver-roundcube-1.2-20 and newer"> |
| + | To change to public access do |
| + | config setprop roundcube access public |
| + | systemctl restart httpd-e-smith |
| + | or to change to private access (lan + authorized external IP) |
| + | config setprop roundcube access private |
| + | systemctl restart httpd-e-smith |
| | | |
− | Access to Roundcube can be fine-tuned by setting the corresponding property in the configuration DB of SME server:
| + | To disable roundcube |
| + | config setprop roundcube status disabled |
| + | signal-event smeserver-roundcube-update |
| + | To enable roundcube |
| + | config setprop roundcube status enabled |
| + | signal-event smeserver-roundcube-update |
| + | |
| + | </tab><tab name="For SME 10 before 1.2-20"> |
| + | 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 this command: |
| + | systemctl restart httpd-e-smith |
| + | </tab><tab name="For SME 8, 9"> |
| config setprop roundcube PublicAccess OPTION | | config setprop roundcube PublicAccess OPTION |
| | | |
Line 77: |
Line 134: |
| | | |
| none => No access | | none => No access |
− | local => Local network (no password required) | + | local => Local network (no password required) |
− | local-pw => Local network (password required) | + | local-pw => Local network (password required) |
− | global => Entire Internet(no password required, this is the default on SME) | + | global => Entire Internet (no password required, this is the default on SME) |
− | global-pw => Entire Internet(password required) | + | global-pw => Entire Internet (password required) |
− | global-pw-remote => Entire Internet(password required outside local network) | + | global-pw-remote => Entire Internet (password required outside local network) |
| | | |
| For example, to restrict access to LAN only: | | For example, to restrict access to LAN only: |
Line 87: |
Line 144: |
| config setprop roundcube PublicAccess local | | config setprop roundcube PublicAccess local |
| | | |
− | To activate these changes to the configuration DB, run these commands | + | To activate these changes to the configuration DB, run these commands: |
| | | |
| expand-template /etc/httpd/conf/httpd.conf | | expand-template /etc/httpd/conf/httpd.conf |
Line 93: |
Line 150: |
| | | |
| afterwards. | | afterwards. |
| + | </tab></tabs> |
| + | |
| | | |
− | Note: For a general description of how DB settings work on SME server, have a look at [[Web Application RPM#New DB settings]].
| |
| | | |
− | === Customization ===
| |
| | | |
| + | Note: for a general description of how DB settings work on SME server, have a look at [[Web Application RPM#New DB settings]]. |
| | | |
| + | === Customization === |
| + | {| class="wikitable" |
| + | |+ |
| + | config setprop roundcube |
| + | !property |
| + | !default |
| + | !accepted |
| + | !comment |
| + | |- |
| + | |Dbname |
| + | |roundcube |
| + | | |
| + | | |
| + | |- |
| + | |DbPassword |
| + | | |
| + | | |
| + | | |
| + | |- |
| + | |DbUser |
| + | | |
| + | | |
| + | | |
| + | |- |
| + | |Name |
| + | |RoundCube IMAP Client |
| + | | |
| + | | |
| + | |- |
| + | |URL |
| + | | |
| + | |string |
| + | |you can add an URL to your domains as an http alias. Could be webmail (if default webmail is deactivated) |
| + | |- |
| + | |PluginsList |
| + | |globaladdressbook,contextmenu,markasjunk,vcard_attachments,newmail_notifier,emoticons,managesieve,nextcloud_attachments |
| + | |comma separated list |
| + | |if you need to add or remove a plugin you need to alter this string in order to get it detected |
| + | |- |
| + | |access |
| + | |public |
| + | |private,public |
| + | | |
| + | |- |
| + | |status |
| + | |enabled |
| + | |enabled,disabled |
| + | | |
| + | |- |
| + | |MaxUploadSize |
| + | |100M |
| + | | |
| + | | |
| + | |- |
| + | |MemoryLimit |
| + | |512M |
| + | | |
| + | | |
| + | |- |
| + | |PHPBaseDir |
| + | |/usr/share/roundcubemail:/etc/roundcubemail/:/var/log/roundcubemail:/var/lib/roundcubemail:/var/log/roundcube.log:/var/lib/php/roundcube:/home/e-smith/files/roundcube:/dev/urandom:/proc/meminfo:/usr/share/GeoIP/GeoLite2-Country.mmdb:/proc/cpuinfo |
| + | |strings separated by : |
| + | |the property will be added to the existing string |
| + | |- |
| + | |PHPmaxChildren |
| + | |20 |
| + | |number |
| + | | |
| + | |- |
| + | |PHPminServers |
| + | |4 |
| + | |number |
| + | | |
| + | |- |
| + | |PHPstartServers |
| + | |6 |
| + | |number |
| + | | |
| + | |- |
| + | |PHPmaxServers |
| + | |8 |
| + | |number |
| + | | |
| + | |- |
| + | |PHPmaxRequests |
| + | |1000 |
| + | |number |
| + | | |
| + | |- |
| + | |nextcloudURI |
| + | |<nowiki>https://$DomainName/nextcloud</nowiki> or <nowiki>https://$nextcloud{'Virtualhost'}</nowiki> |
| + | | |
| + | |will override default, usefull if nextcloud is not on the same server |
| + | |- |
| + | |nextcloudFolder |
| + | |Mail Attachments |
| + | |string |
| + | |can not be a subfolder |
| + | |- |
| + | |NCsoftlimit |
| + | |<nowiki>$qmail{'MaxMessageSize'}||'25M'</nowiki> |
| + | |number with M |
| + | |limit size for attachements |
| + | |- |
| + | |nextcloudBehavior |
| + | |prompt |
| + | |prompt,upload |
| + | |show dialog or upload directly |
| + | |- |
| + | |nextcloudVerifyCerts |
| + | |true |
| + | |true,false |
| + | |allow you to override cert verification in case of self signed cert |
| + | |} |
| + | then |
| + | signal-event roundcube-update |
| ====Roundcube plugins==== | | ====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,markasjunk2,vcard_attachments,newmail_notifier,emoticons,tasklist,managesieve''
| |
| | | |
| =====Installing additional plugins===== | | =====Installing additional plugins===== |
Line 119: |
Line 285: |
| | | |
| '''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! |
− | * for sme8
| + | <tabs container=""><tab name="For SME 10"> |
| + | cd /usr/share/roundcubemail |
| + | /usr/bin/php74 /usr/local/bin/composer require cor/message_highlight --with-dependencies |
| + | </tab><tab name="For SME 9"> |
| + | 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" |
| + | }, |
| + | |
| + | </tab><tab name="For SME 8"> |
| nano /opt/roundcube/composer.json | | nano /opt/roundcube/composer.json |
− | * for sme9
| |
− | nano /usr/share/roundcubemail/composer.json
| |
| | | |
| "require": { | | "require": { |
Line 132: |
Line 311: |
| "cor/message_highlight": "dev-master" | | "cor/message_highlight": "dev-master" |
| }, | | }, |
| + | </tab></tabs> |
| | | |
| '''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 |
Line 144: |
Line 324: |
| config getprop roundcube PluginsList | | config getprop roundcube PluginsList |
| | | |
− | ''PluginsList=globaladdressbook,carddav,calendar,libcalendaring,contextmenu,markasjunk2,vcard_attachments,newmail_notifier,emoticons,tasklist,managesieve'' | + | ''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: | | '''Step 5b:''' Add your newly installed plugin to the list (separated by a comma (,) and without spaces) and activate the change: |
Line 161: |
Line 341: |
| rcplugin_update.sh | | rcplugin_update.sh |
| | | |
− | ====Customize Roundcube settings==== | + | ====Miscellaneous notes==== |
− | | |
− | 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
| |
− | 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 /opt/roundcube/config/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/opt/roundcube/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 /opt/roundcube/plugins/managesieve/config.inc.php
| |
− | | |
− | * 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''
| |
− | ''...''
| |
− | | |
− | * 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:
| |
− | signal-event roundcube-update
| |
− | {{Note box|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 box|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 box|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)==== | | ====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 (reverse [[#Adding additional plugins|Step 5 described above]], ie. remove <tt>managesieve</tt> from the list of installed plugins). | + | Roundcube on SME server comes with the managesieve plugin installed and enabled by default (sieverules has been deprecated and you must only use managesieve). 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. |
| | | |
− | =====Managesieve or sieverules=====
| |
− |
| |
− | you have 2 plugins which are able to manage sieve and therefore the vacation message managesieve (provided in the bundle) and sieverules provided by composer. '''You must select one.'''
| |
− |
| |
− | config setprop roundcube PluginsList globaladdressbook,calendar,libcalendaring,contextmenu,markasjunk2,vcard_attachments,newmail_notifier,emoticons,tasklist,managesieve
| |
− | or
| |
− | config setprop roundcube PluginsList globaladdressbook,calendar,libcalendaring,contextmenu,markasjunk2,vcard_attachments,newmail_notifier,emoticons,tasklist,sieverules
| |
− | and
| |
− | signal-event roundcube-update
| |
| =====Troubleshooting===== | | =====Troubleshooting===== |
| * If mails are not correctly filtered by the filters configured in user's roundcube settings, check the following: | | * If mails are not correctly filtered by the filters configured in user's roundcube settings, check the following: |