Sogo

From SME Server
Jump to: navigation, search

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

SOGo - Scaleable OpenGroupware.org

http://www.sogo.nu

SOGo is a groupware server built around OpenGroupware.org (OGo) and the SOPE application server. It focuses on scalability.

SOGo provides a rich AJAX-based Web interface and supports multiple native clients through the use of standard protocols such as CalDAV, CardDAV and GroupDAV.

Once configured, SOGo offers multiple ways to access the calendaring and messaging data. Your users can either use a web browser, Mozilla Thunderbird, Apple iCal, or a mobile device to access the same information. SOGo provides native Microsoft ActiveSync support. Mobile devices such as Apple iPhone, Android, Windows Phone, and BlackBerry 10 can fully synchronize emails, contacts, events and tasks with SOGo.

Maintainer

Stéphane de Labrusse AKA Stephdl

The original work has been made by nethesis. Many thanks to all previous developers

Requirements

SOGo requires SME 8 or SME 9

Install SOGO 2

For SME 8

Important.png Note:
due to the version of dovecot, I cannot maintain sogo for sme8, please upgrade to sme9

You need to activate Stephdl, epel and sogo repository


Warning.png Warning:
due to the limitation of dovecot 1.0 in SME server 8.0, you cannot use sogo (superior of 2.0 version) without bugs. If it is absolutely needed (eg : you should use SME9) you can install smeserver-dovecot from firewall-services : https://wikit.firewall-services.com/doku.php/smedev/dovecot

This contrib is currently held in several repositories, so the following commands will install it on your smeserver. For SME 8 , You need to activate Stephdl, epel and sogo repository

yum --enablerepo=stephdl,epel,sogo install smeserver-sogo

You will then need to activate the database changes etc. The 'official' way is to perform

signal-event post-upgrade;  signal-event reboot

or if you don't want to reboot your server

signal-event sogo-modify; config set UnsavedChanges no

For SME 9

You need to activate Stephdl, epel and sogo repository


This contrib is currently held in several repositories, so the following commands will install it on your smeserver. For SME 9 , You need to activate Stephdl, epeland sogo repository

yum --enablerepo=stephdl,epel,sogo,fws install smeserver-sogo

You will then need to activate the database changes etc. The 'official' way is to perform

signal-event post-upgrade;  signal-event reboot

or if you don't want to reboot your server

signal-event sogo-modify; config set UnsavedChanges no

Install SOGO 3 (ONLY SME9)

First installation

This contrib is currently held in several repositories, so the following commands will install it on your smeserver. For SME 9 , You need to activate Stephdl, epel and sogo repository

yum --enablerepo=stephdl,epel,sogo3,fws install smeserver-sogo

You will then need to activate the database changes etc. The 'official' way is to perform

signal-event post-upgrade;  signal-event reboot

or if you don't want to reboot your server

signal-event sogo-modify; config set UnsavedChanges no

Upgrade from sogo2

For SME 9 , You need to activate Stephdl, epel, fws and sogo repository

signal-event yum-modify
yum update  --enablerepo=sogo3
yum reinstall sope\* --enablerepo=sogo3

You will then need to activate the database changes etc. The 'official' way is to perform

signal-event post-upgrade;  signal-event reboot

or if you don't want to reboot your server

signal-event sogo-modify; config set UnsavedChanges no

Usage

To access webmail and calenders, open the url http://yourdomain.net/SOGo

If you disable webmail access from within SmeServer email panel, opening http://yourdomain.net/webmail you'll be redirected to SOGo.


DB

On SME9

sogod=service
   ACLsSendEMailNotifications=NO
   ActiveSync=disabled
   AdminUsers=admin
   DbPassword=NjPvjv3SPxb+s37.AKPGGGjFIeQJykYoPnL9oI.48d8qhsW3luZhQnMqrGurcBGU3Q23w77gp1+o
   DraftsFolder=Drafts
   SpamFolder=Junk
   EnableEMailAlarms=NO
   LdapTCPPort=389
   MailAuxiliaryUserAccountsEnabled=YES
   PublicAccess=NO
   SOGoInternalSyncInterval=60
   SOGoMaximumPingInterval=3540
   SOGoMaximumSyncInterval=3540
   SOGoMaximumSyncResponseSize=2048
   SOGoMaximumSyncWindowSize=100
   SentFolder=Sent
   SessionDuration=1440
   TCPPort=20000
   TrashFolder=Trash
   WOWatchDogRequestTimeout=3600
   WOWorkersCount=10
   status=enabled

After a modification

signal-event sogo-modify

Sieve integration (SME 9)

Installing SOGo on SME 9 according to the instructions above also installs smeserver-dovecot-extras as a dependency. In order to make full use of sieve functionality in SOGo (such as auto expiration of vacation messages), make sure that the following property is enabled in the configuration database:

db configuration setprop dovecot AdminIsMaster enabled

signal-event email-update

Special Settings (SME 9)

Sogo is full of settings that I cannot provide all, please read the sogo's book

Now when you want to add a specific option, 'SOGoMailComposeMessageType html' per example

vim /etc/e-smith/templates/etc/sogo/sogo.conf/80MYOPTIONS

Add you modifications (contrary is 'text')

SOGoMailComposeMessageType = html;

Expand and restart sogo

signal-event sogo-modify

If you want to go back, then

rm -f /etc/e-smith/templates/etc/sogo/sogo.conf/80MYOPTIONS
signal-event sogo-modify

Log

All events are logged in the relevant log file

less /var/log/sogo/sogo.log

Documentation

Please RTFM instead of raising bugs against smeserver-sogo :)

You have more documentation available here on all SOGo's aspects


You can fine tune thunderbird to be a pure "heavy" client for SOGo. See the Documentation

Fine tune SOGo

Sogo must be tuned following the number of users, some settings can be tested.

Keep in mind to set one worker per user for the activesync connection.

  • 100 users, 10 EAS devices
config setprop sogod WOWorkersCount 15
config setprop sogod SOGoMaximumPingInterval 3540
config setprop sogod SOGoMaximumSyncInterval 3540
config setprop sogod SOGoInternalSyncInterval 30
signal-event sogo-modify
  • 100 users, 20 EAS devices
config setprop sogod WOWorkersCount 25
config setprop sogod SOGoMaximumPingInterval 3540
config setprop sogod SOGoMaximumSyncInterval 3540
config setprop sogod SOGoInternalSyncInterval 40
signal-event sogo-modify
  • 1000 users, 100 EAS devices
config setprop sogod WOWorkersCount 120
config setprop sogod SOGoMaximumPingInterval 3540
config setprop sogod SOGoMaximumSyncInterval 3540
config setprop sogod SOGoInternalSyncInterval 60
signal-event sogo-modify

ImapMaxLineLength

Maximum IMAP command line length in kilo bytes. Some clients generate very long command lines with huge mailboxes, so you may need to raise this if you get "Too long argument" or "IMAP command line too large" errors often.

set by default to 2048KB

config setprop dovecot ImapMaxLineLenght 2048
signal-event sogo-modify

Thunderbird Configuration

You are encouraged to use Thunderbird ESR (Extended Support Release) and corresponding compatible Lightning plugin. According to Mozilla Team "Thunderbird Extended Support Release (ESR) is intended for groups who deploy and maintain the desktop environment in large organizations such as universities and other schools, county or city governments and businesses". Furthermore the latest releases of Lightning plugin is fully SOGo compatibile, so no more need of a SOGo customized version.

1.) From a Windows client create the folder "SOGo-plugins\WINNT_x86-msvc" in your Primary ibay "html" folder (e.g. \\<SME server name>\Primary\hmtl\SOGo-plugins\WINNT_x86-msvc)

2.) Download the latest Lightning, Connector and Integrator plugins from [1] and place them in the "WINNT_x86-msvc" folder.

3.) Rename "sogo-integrator-<version>-sogo-demo.xpi" to "sogo-integrator-<version>-sogo.xpi". (This is optional)

4.) Open the "sogo-integrator-<version>-sogo.xpi" file with your favorite zip program (it is just a renamed zip file. 7-zip works nicely for this) and edit the file "\chrome\content\sogo-integrator\extensions.rdf".

Change the following lines:

       <Seq about="http://inverse.ca/sogo-integrator/extensions"
           isi:updateURL="http://sogo-demo.inverse.ca/plugins/updates.php?plugin=%ITEM_ID%&version=%ITEM_VERSION%&platform=%PLATFORM%">
           <li>
             <Description
               em:id="sogo-integrator@inverse.ca"
               em:name="SOGo Integrator"/>
           </li>
           <li>
             <Description
               em:id="sogo-connector@inverse.ca"
               em:name="SOGo Connector"/>
           </li>
         </Seq>

To read: (change the server address to your server and add the Lightning plugin to the extensions list): (Then save the "extensions.rdf" back to the same place in the "sogo-integrator-<version>-sogo.xpi" file and then save the .xpi file back on the server in the "\\<SME server name>\Primary\hmtl\SOGo-plugins\WINNT_x86-msvc" folder.)

       <Seq about="http://inverse.ca/sogo-integrator/extensions"
           isi:updateURL="https://<sme server name.domain>/SOGo-plugins/updates.php?plugin=%ITEM_ID%&version=%ITEM_VERSION%&platform=%PLATFORM%">
           <li>
             <Description
               em:id="sogo-integrator@inverse.ca"
               em:name="SOGo Integrator"/>
           </li>
           <li>
             <Description
               em:id="sogo-connector@inverse.ca"
               em:name="SOGo Connector"/>
           </li>
           <li>
 	      <Description
 		em:id="{e2fda1a4-762b-4020-b5ad-a41df1933103}"
 		em:name="Lightning"/>
           </li>
         </Seq>

5.) Create the file "updates.php" in the "SOGo-plugins" folder

6.) Add the following lines to the file: (Please note you must customize the "version =>", "filename =>" and "<em:updateLink>http://<sme server name.domain>/SOGo-plugins/<?php echo $plugin["filename"] ?></em:updateLink>" in the lines below!)

    <?php
      /* updates.php - this file is part of SOGo
       *
       *  Copyright (C) 2006-2009 Inverse inc.
       *
       * Author: Wolfgang Sourdeau <wsourdeau@inverse.ca>
       *
       * This file is free software; you can redistribute it and/or modify
       * it under the terms of the GNU General Public License as published by
       * the Free Software Foundation; either version 2, or (at your option)
       * any later version.
       *
       * This file is distributed in the hope that it will be useful,
       * but WITHOUT ANY WARRANTY; without even the implied warranty of
       * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
       * GNU General Public License for more details.
       *
       * You should have received a copy of the GNU General Public License
       * along with this program; see the file COPYING.  If not, write to
       * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
       * Boston, MA 02111-1307, USA.
       */
      
      /* This script handles the automatic propagation of extensions pertaining to a
         SOGo site. It requires PHP 4.1.0 or later. */
      $plugins
      = array( "sogo-connector@inverse.ca"
               => array( "application" => "thunderbird",
                         "version" => "0.99",
                         "filename" => "sogo-connector-0.99.xpi" ),
               "sogo-integrator@inverse.ca"
               => array( "application" => "thunderbird",
                         "version" => "0.99",
                         "filename" => "sogo-integrator-0.99-sogo.xpi" ),
               "{e2fda1a4-762b-4020-b5ad-a41df1933103}"
               => array( "application" => "thunderbird",
                         "version" => "0.9.9",
                         "filename" => "lightning-0.9.9-inverse.win32.xpi" ));
      
      $applications
      = array( "thunderbird" => "<em:id>{3550f703-e582-4d05-9a08-453d09bdfdc6}</em:id>
                      <em:minVersion>1.5</em:minVersion>
                      <em:maxVersion>2.0.*</em:maxVersion>",
               "firefox" => "<em:id>{ec8030f7-c20a-464f-9b0e-13a3a9e97384}</em:id>
                         <em:minVersion>1.5</em:minVersion>
                         <em:maxVersion>2.0.*</em:maxVersion>" );
      
      $pluginname = $_GET["plugin"];
      $plugin =& $plugins[$pluginname];
      $application =& $applications[$plugin["application"]];
      
      if ( $plugin ) {
        $platform = $_GET["platform"];
        if ( $platform
             && file_exists( $platform . "/" . $plugin["filename"] ) ) {
          $plugin["filename"] = $platform . "/" . $plugin["filename"];
        }
        elseif ( !file_exists( $plugin["filename"] ) ) {
          $plugin = false;
        }
      }
      if ( $plugin ) {
        header("Content-type: text/xml; charset=utf-8");
        echo ('<?xml version="1.0"?>' . "\n");
      ?>
      <!DOCTYPE RDF>
      <RDF xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
        xmlns:em="http://www.mozilla.org/2004/em-rdf#">
        <Description about="urn:mozilla:extension:<?php echo $pluginname ?>">
          <em:updates>
            <Seq>
              <li>
                <Description>
                  <em:version><?php echo $plugin["version"] ?></em:version>
                  <em:targetApplication>
                    <Description><?php echo $applications[$plugin["application"]] ?>
                      <em:updateLink>https://<sme server name.domain>/SOGo-plugins/<?php echo $plugin["filename"] ?></em:updateLink>
                    </Description>
                  </em:targetApplication>
                </Description>
              </li>
            </Seq>
          </em:updates>
        </Description>
      </RDF>
      <?php
      } else {
        header("Content-type: text/plain; charset=utf-8", true, 404);
        echo( 'Plugin not found' );
      }
      ?>

(You will have to update this file everytime you update the plugins.)

7.) Install the Thunderbird ESR and configure it to use the SME IMAP email.

8.) Install the "sogo-integrator-<version>-sogo.xpi" plugin you modified, into Thunderbird and restart Thunderbird. Sogo will then go to the server and install the other plugins as configured in your "updates.php" file. As default the SOGo-Thunderbird components will associate Calendar and Addressbook to the Sme user/account corresponding to default Thunderbird Imap mail account; so take care to set the desired Imap account as default in Thunderbird before installing plugins.


Now you can create and share address books and calendars in Thunderbird with other SME users and control access rights to them. Your calendars and address books will also sync with the SOGO webmail page as well as any other computers where you have the SOGO Integrator plugin installed.

To configure other devices refer to website; look however at SOGo official up-to-date front-end software and documentation with latest upgrades for server, client and device configuration (http://www.sogo.nu/downloads/frontends.html - http://www.sogo.nu/downloads/documentation.html).

Mixed warnings

You can experience some problem with IMAP authentication: you can login to SOGo but you can't see mail messages; only admin can see his mail. Looking at sogo log you can find erros like this:

Aug 15 21:41:04 sogod [19261]: [ERROR] <0x0xba13edec[NGImap4ConnectionManager]> IMAP4 login failed:
 host=localhost, user=xxxxxx, pwd=yes
 url=imap://xxxxxx@localhost/
 base=(null)
 base-class=(null))
 = <0x0xba14cdec[NGImap4Client]: login=xxxxxx(pwd) socket=<NGActiveSocket[0x0xba14d194]: mode=rw address=<0x0xba14d1d4[NGInternetSocketAddress]: host=localhost port=35161>  connectedTo=<0x0xba14cebc[NGInternetSocketAddress]: host=localhost port=143>>>
Aug 15 21:41:04 sogod [19261]: [ERROR] <0xBA13C964[SOGoMailAccount]:0> Could not connect IMAP4
xxx.xxx.xxx.xxx - - [15/Aug/2014:21:41:04 GMT] "POST /SOGo/so/xxxxxx/Mail/0/mailboxes HTTP/1.1" 200 17/0 0.018 - - 252K
xxx.xxx.xxx.xxx - - [15/Aug/2014:21:41:04 GMT] "POST /SOGo/so/xxxxxx/Mail/1/mailboxes HTTP/1.1" 200 343/0 0.243 - - 24K
xxx.xxx.xxx.xxx - - [15/Aug/2014:21:41:05 GMT] "POST /SOGo/so/xxxxxx/Mail/1/folderINBOX/unseenCount HTTP/1.1" 200 13/0 0.263 - - 48K

This seems related to users not belonging to a group; so be careful that all of your users belong to a group before using SOGo. For existing users:

Create a group
Reset the users password
Add user to the group

More details can be found in this post:

http://forums.contribs.org/index.php/topic,51038.0.html

Reference

https://wiki.nethserver.org/doku.php?id=sogo&s

http://www.sogo.nu/english/support/documentation.html


Upgrade

yum --enablerepo=stephdl,epel,sogo update smeserver-sogo sogo\* libmemcached
signal-event sogo-modify

Uninstall

yum remove sope* libwbxml gnustep* smeserver-sogo xmlsec* \
memcached python-memcached sogo* dovecot-pigeonhole smeserver-dovecot-extras libobjc libmemcached

Bugzilla

Open

IDStatusComponentVersionSummary (6 tasks)
10465UNCONFIRMEDsmeserver-sogo9.2Error message returned as Vacation auto reply
9916UNCONFIRMEDsmeserver-sogo9.1Sogo/ActiveSync Freebusy empty file issue
8862UNCONFIRMEDsmeserver-sogo9.0Yum hangs when updating to smeserver-sogo-1.3-12.el6.sme.noarch
8847CONFIRMEDsmeserver-sogo9.0Domain name hardcoded, not considering virtual domains
8348CONFIRMEDsmeserver-sogo8.1Error adding a second attachments composing a message in SOGo
7674UNCONFIRMEDsmeserver-sogo8.0smeserver-sogo: need to change /etc/sysconfig/memcached

Closed

IDStatusComponentVersionSummary (7 tasks)
10269CLOSEDsmeserver-sogo9.2SOGO - WOWorkersCount does not get set via "config setprop sogod WOWorkersCount 25" command
10168CLOSEDsmeserver-sogo9.1Sogo: ActiveSync drains iphone battery with Contacts enabled
9908CLOSEDsmeserver-sogo9.1Incorrect syntax in (s80-)sogobackup
9699CLOSEDsmeserver-sogo9.1Problem with restarting sogod
8756CLOSEDsmeserver-sogo9.0sogo-ealarms-notify cronjob fills up qmail log
8753CLOSEDsmeserver-sogo9.0Automatic expiry of vacation messages in SOGo broken (Authentication failure for sogo user)
8452CLOSEDsmeserver-sogo9betaSOGo on SME9: missing dependency