RoundCube

From SME Server
Revision as of 19:09, 21 November 2014 by Stephdl (talk | contribs) (→‎Usage)
Jump to navigation Jump to search
Geographylogo.png Languages: 

English  • Deutsch  • français


PythonIcon.png 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 for SME Server V0.9.5

Maintainer

stephdl Stéphane de Labrusse AKA Stephdl

Dungog.net (Software) : original developper

Description

RoundCube Webmail is a browser-based multilingual IMAP client with an application-like user interface. It provides full functionality you expect from an e-mail client, including MIME support, address book, folder manipulation, message searching and spell checking. For more information see http://www.roundcube.net/. Actually roundcube is only available with beta status, but it run very fast and stable.

Installation

Install from the SME Contribs repository issue the following command on the SME Server shell: 

yum --enablerepo=smecontribs install smeserver-roundcube

If you do not want to restart your server 

signal-event conf-roundcube; signal-event console-save

or 

signal-event post-upgrade; signal-event reboot

Uninstallation

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

rpm -e roundcube smeserver-roundcube

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 : 

less /opt/roundcube/logs/errors

Options

You can fine tune access to roundcube with DB settings. For details have a look at Web Application RPM#New DB settings.


Activate Roundcube Plugin

Plugins need to be allowed in the main.config.php of roundcube, you can also write options in this file. If you want to modify options you have to modify the template in /etc/e-smith/templates/opt/roundcube/config/main.inc.php/20plugin

Please add all plugins you want to activate in the command line below : 

$rcmail_config['plugins'] = array('plugin1','plugin2','plugin3');

where "plugin*" is a valid name of plugin and a valid folder name in /opt/roundcube/plugins

see the file 20plugin for example 

nano /etc/e-smith/templates/opt/roundcube/config/main.inc.php/20plugin

save by ctrl+x 

expand-template /opt/roundcube/config/main.inc.php

Your personal 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.

For example do 

nano /etc/e-smith/templates/opt/roundcube/config/main.inc.php/21plugin-personal

with all your special options you want and perform this CL to expand templates 

expand-template /opt/roundcube/config/main.inc.php

You can read the file below to know further options you can activate 

less /opt/roundcube/config/main.inc.php.dist

All plugins in /opt/roundcube/plugins/ comes with their own config.inc.php.dist which you can use to set default options.


Limit access to roundcube

config setprop roundcube PublicAccess OPTION

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)
       global-pw        => Entire Internet(password required)
       global-pw-remote => Entire Internet(password required outside local network)


  Note:
the global option is already the default option to control access to this contribs 


config setprop roundcube PublicAccess global

To enable your changes run these commands 

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

Add a different URL

by example 

http://yourserver.net/webmail

or 

http://yourserver.net/mail


  Warning:
This URL of /webmail is used by the horde webmail, so you have to deactivated the webmail in the server-manager



  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

Local Settings

The config file is now templated, so changes need to be made in a new fragment

  • eg. /etc/e-smith/templates/opt/roundcube/config/main.inc.php/20local

check which setting you want to change with 

cat /opt/roundcube/config/main.inc.php.dist

then add the new setting in the new fragment and expand, it will overrule the old 

expand-template /opt/roundcube/config/main.inc.php

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

Bugs

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

RoundCube for SME Server V1.0

Maintainer

stephdl Stéphane de Labrusse AKA Stephdl

Installation

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 conf-roundcube; signal-event console-save

or 

signal-event post-upgrade; signal-event reboot

For SME9

Remember to first configure the required stephdl repository, then issue the following command on the SME Server shell: 

yum install smeserver-roundcube --enablerepo=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 conf-roundcube; signal-event console-save

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.

Options

You can fine tune access to roundcube with DB settings. For details have a look at Web Application RPM#New DB settings.

Activate Roundcube Plugins

the major change is the roundcube plugin repository, however there are not too much available now, but with time there will be more.

if you need more plugins, you can see http://plugins.roundcube.net/packages/ and you have to add the package name in composer.json. Take attention to the coma (,) it is really important. 

# 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",
      	"johndoh/copymessage": "dev-release-1.0"
    },

after each modification launch 

rcplugin_update.sh

Answer yes or not to the question. Once done, if you want to activate plugin, you need to use the db command (need to be activated only one time) Add them to the db command (Here are the plugins that come by default with the program) 

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

in order to modify, you must add your plugin list with coma 

config setprop roundcube PluginsList globaladdressbook,carddav,calendar,libcalendaring,contextmenu,markasjunk2,vcard_attachments,newmail_notifier,emoticons,tasklist,copymessage 
signal-event conf-roundcube

Now when you want to update your plugin list, you can issue simply 

 rcplugin_update.sh

Local Settings

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

check which setting you want to change with 

cat /opt/roundcube/config/config.inc.php.sample

then add the new setting in the new fragment and expand, it will overrule the old 

expand-template /opt/roundcube/config/config.inc.php

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

Limit access to roundcube

config setprop roundcube PublicAccess OPTION

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)
       global-pw        => Entire Internet(password required)
       global-pw-remote => Entire Internet(password required outside local network)


  Note:
the global option is already the default option to control access to this contribs 


config setprop roundcube PublicAccess global

To enable your changes run these commands 

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

Add a different URL

by example 

http://yourserver.net/webmail

or 

http://yourserver.net/mail


  Warning:
This URL of /webmail is used by the horde webmail, so you have to deactivated the webmail in the server-manager



  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
Retrieved from "https://wiki.koozali.org/index.php?title=RoundCube&oldid=26257"