Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
sogo [2018/01/14 09:34]
Stephane de Labrusse
sogo [2018/01/14 09:34] (current)
Stephane de Labrusse
Line 5: Line 5:
 </​WRAP>​ </​WRAP>​
  
-  * SOGo is a fully supported and trusted groupware server with a focus on scalability and open standards. SOGo is released under the GNU GPL/LGPL v2 and above. 
-  * 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, as well as Microsoft ActiveSync. 
-  * SOGo is the missing component of your infrastructure;​ it sits in the middle of your servers to offer your users a uniform and complete interface to access their information. It has been deployed in production environments where thousands of users are involved. 
- 
- 
-<WRAP center round important 60%> 
-  * SOGo provides EAS (Exchange ActiveSync) support, but not EWS (Exchange Web Service). 
-  * Outlook 2013, 2016 for Windows works well with EAS. 
-  * Mainstream mobile devices (iOS, Android, BlackBerry 10) work well with EAS, they can sync mails, calendars, contacts, tasks. 
-  * Apple Mail.app, and Outlook for Mac support EWS. But not EAS. 
-  * **Clients work very well with POP3/IMAP account, caldav/​carddav account** 
-</​WRAP>​ 
- 
-<WRAP center round tip 60%> 
- ​Nethserver-sogo doesn'​t integrate OpenChange and Samba4 for native MAPI support, so SOGo groupware doesn'​t provide full support for Microsoft Outlook clients, Mac OS X Mail.app and all iOS devices, don't try to add your mail account as an Exchange account in these mail clients. You have to add account as POP3/IMAP account, caldav/​carddav account instead. 
-</​WRAP>​ 
- 
- 
- 
-=====Maintainer===== 
- 
-Stephane de Labrusse at [[stephdl@de-labrusse.fr]] 
- 
-I'm not the original author of this module, [[https://​github.com/​NethServer/​nethserver-sogo/​commits/​master|thank to all involved people]]. 
- 
-=====Installation===== 
- 
-<WRAP center round tip 60%> 
-You need first to set an account provider which can be local (nethserver-directory for openldap or nethserver-dc for Samba AD) or remote (whatever openldap or samba AD choice). You cannot mix your choice by openldap and Samba AD, preferably if you plan to host samba shares with user authentication,​ you need samba AD (nethserver-dc) 
-</​WRAP>​ 
- 
- 
-then go to install nethserver-sogo 
- 
-  yum install nethserver-sogo 
- 
-or go to the software center :)  
- 
-=====Documentation ===== 
-Please [[https://​sogo.nu/​files/​docs/​SOGoInstallationGuide.html|RTFM]],​ your solution is in this book 
-===== Usage ===== 
- 
-the url of the groupware is https://​yourdomain.com/​SOGo. You can use the '​username'​ or '​username@domain.com'​ for login 
- 
-====Esmith database==== 
- 
-You can modify the available properties of  sogo 
- 
-  sogod=service 
-    ActiveSync=enabled 
-    AdminUsers=admin 
-    BackupTime=30 0 
-    Certificate= 
-    Dav=enabled 
-    DraftsFolder=Drafts 
-    IMAPLoginFieldName=userPrincipalName 
-    MailAuxiliaryUserAccountsEnabled=YES 
-    Notifications=Appointment,​EMail ​             #'​Folder'/'​ACLs'/'​Appointment'​ 
-    SOGoInternalSyncInterval=10 
-    SOGoMaximumPingInterval=10 
-    SOGoMaximumSyncInterval=30 
-    SOGoMaximumSyncResponseSize=2048 
-    SOGoMaximumSyncWindowSize=100 
-    SentFolder=Sent 
-    SxVMemLimit=512 
-    TrashFolder=Trash 
-    VirtualHost= 
-    WOWatchDogRequestTimeout=10 
-    WOWorkersCount=10 
-    status=enabled 
- 
- 
-* AdminUsers: Parameter used to set which usernames require administrative privileges over all the users tables. 
-* BackupTime: Time to launch the backup, by default ('30 0'​)each day at 00h30, you can change it if you set a cron compatible value '* *' 
- 
-* DraftsFolder:​ name of draft folder, default is ‘Drafts’ 
-*  IMAPLoginFieldName:​ adjust the imap login field to your good trusted value in your ldap (see https://​community.nethserver.org/​t/​sogo-and-ad-brainstorming/​8024/​31) 
-* SentFolder: name of the sent folder, default is ‘Sent’ 
-* TrashFolder:​ name of the trash folder, default is ‘Trash’ 
-* WOWorkersCount:​ The amount of instances of SOGo that will be spawned to handle multiple requests simultaneously 
-* MailAuxiliaryUserAccountsEnabled:​ Parameter used to activate the auxiliary IMAP accounts in SOGo. When set to YES, users can add other IMAP accounts that will be visible from the SOGo Webmail interface. 
-* Notifications:​ enabled notifications. The value is a comma separated list. Default value is “Appointment,​ EMail” 
- 
-====Notes==== 
- 
-**bold** terms are documented in SOGo [[https://​sogo.nu/​files/​docs/​SOGoInstallationGuide.html#​_preferences_hierarchy|installation and configuration guide]] 
- 
-  * //​AdminUsers//​ comma separated list of accounts allowed to bypass SOGo ACLs. See **SOGoSuperUsernames** key 
-  * Notifications comma separated list of values (no spaces between commas). Known item names are //ACLs//, //​Folders//,​ //​Appointments//​. See **SOGoSendEMailNotifications** 
-  * //​{Drafts,​Sent,​Trash}Folder//​ See respective **SOGoFolderName** parameters 
-  * //​VirtualHosts//​ comma separated list of host keys in //hosts// DB, with //​type=self//​. SOGo is reachable from the default host name plus any host listed here (see #2371). 
- 
- 
- 
- 
-====Access SOGo from the public network==== 
- 
-To make SOGo accessible with a public DNS hostname: 
- 
-*In “DNS and DHCP” UI module (Hosts), create the DNS host name as a server alias (i.e. public.example.com) 
-*Add the host name to sogod/​VirtualHosts prop list: 
- 
-<​file>​ 
-config setprop sogod VirtualHosts public.example.com 
-signal-event nethserver-sogo-update 
-</​file>​ 
- 
-Same rule applies if SOGo must be accessible using server IP address. For example: 
- 
-<​file>​ 
-config setprop sogod VirtualHosts 192.168.1.1 
-signal-event nethserver-sogo-update 
-</​file>​ 
- 
-====ImapMaxLineLenght==== 
- 
-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 nethserver-sogo-update 
-  ​ 
-====ActiveSync==== 
-According to this http://​docs.nethserver.org/​en/​v7/​webtop5.html#​webtop-vs-sogo2 
- 
-"​WebTop and SOGo can be installed on the same machine. 
- 
-ActiveSync is enabled by default on SOGo and WebTop, but if both packages are installed, SOGo will take precedence."​ 
- 
-* To disable ActiveSync on SOGo: 
- 
-<​file>​ 
-  config setprop sogod ActiveSync disabled 
-  signal-event nethserver-sogo-update 
-</​file>​ 
- 
-* To disable ActiveSync on WebTop: 
- 
-<​file>​ 
-  config setprop webtop ActiveSync disabled 
-  signal-event nethserver-webtop5-update 
-</​file>​ 
- 
-====Backup Sogo==== 
- 
-Each night (by default) a cron run to backup user data (filter rules, specific settings, events, contacts) and save it to /​var/​lib/​sogo/​backups 
-you can restore the data with a tool '​sogo-restore-user',​ for example 
-<​file>​ 
-sogo-restore-user /​var/​lib/​sogo/​backups/​sogo-2017-12-10_0030/​ stephane 
-</​file>​ 
-or for all users 
-<​file>​ 
-sogo-restore-user /​var/​lib/​sogo/​backups/​sogo-2017-12-10_0030/​ -A 
-</​file>​ 
- 
-if you want to change the time of your backup for example (in this example, run at 4h01 AM) 
- 
-<​file>​ 
-config setprop sogod BackupTime '1 4' 
-signal-event nethserver-sogo-update 
-</​file>​ 
-=====Fine tune SOGo===== 
-==== Adjust Settings==== 
-Sogo [[https://​sogo.nu/​files/​docs/​SOGoInstallationGuide.html#​_microsoft_enterprise_activesync_tuning|must be tuned]] following the number of users, some settings can be tested. 
- 
-<WRAP center round tip 60%> 
-Keep in mind to set one worker per user for the activesync connection. 
-</​WRAP>​ 
- 
- 
-<​file>​ 
-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 nethserver-sogo-update 
- 
-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 nethserver-sogo-update 
- 
-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 nethserver-sogo-update 
-</​file>​ 
- 
-====Increase sogod log verbosity==== 
- 
-Read the [[http://​www.sogo.nu/​nc/​support/​faq/​article/​how-to-enable-more-verbose-logging-in-sogo.html|SOGo FAQ]] for other debugging features. 
- 
-==== Sogo floods /​var/​log/​messages==== 
-you can see this log noise in /​var/​log/​message **(only for ns7)** 
- 
-<​file>​ 
-Dec  4 12:36:01 ns7ad1 systemd: Created slice User Slice of sogo. 
-Dec  4 12:36:01 ns7ad1 systemd: Starting User Slice of sogo. 
-Dec  4 12:36:01 ns7ad1 systemd: Started Session 163 of user sogo. 
-Dec  4 12:36:01 ns7ad1 systemd: Starting Session 163 of user sogo. 
-Dec  4 12:36:01 ns7ad1 systemd: Removed slice User Slice of sogo. 
-Dec  4 12:36:01 ns7ad1 systemd: Stopping User Slice of sogo. 
-</​file>​ 
- 
- 
-These messages are normal and expected -- they will be seen any time a user logs in. To suppress these log entries in /​var/​log/​messages,​ create a discard filter with rsyslog, e.g., run the following command: 
- 
-<​file>​ 
-echo 'if $programname == "​systemd"​ and ($msg contains "​Starting Session"​ or $msg contains "​Started Session"​ or $msg contains "​Created slice" or $msg contains "​Starting User" or $msg contains "​Removed slice User" or $msg contains "​Stopping User") then stop' > /​etc/​rsyslog.d/​ignore-systemd-session-slice-sogo.conf 
-</​file>​ 
-and restart rsyslog 
-<​file>​ 
-systemctl restart rsyslog 
-</​file>​ 
-this solution comes from [[https://​access.redhat.com/​solutions/​1564823|Redhat solution]] 
-=====Redirect Sogo on the root domain===== 
-following this [[http://​community.nethserver.org/​t/​how-redirect-sogo-on-root-domain/​2386|thread]] you can redirect the sogo url to the default domain 
-<​file>​ 
-Add index.php with the following content: 
- 
-<?php 
-header('​Location:​ /​SOGo'​);​ 
- 
-in /​var/​www/​html/​ without Fileserver 
-</​file>​ 
- 
-=====Client===== 
- 
- 
-====Android==== 
- 
-Currently you have 2 ways to integrate your Android device with Sogo 
- 
-===Integration via Caldav /​Cardav/​imap=== 
-<WRAP center round tip 60%> 
-The drawback is that you need to set all settings (Url/​Username/​Password) in each application. 
-</​WRAP>​ 
- 
-* Email 
- 
-Imaps(over ssl) is a good choice, you can use the K9-mail software to retrieve your email or the default email application 
- 
-* Contacts and calendars 
- 
-There are various working clients, including DAVdroid https://​davdroid.bitfire.at (open-source) and CalDAV-Sync/​CardDav-Sync http://​dmfs.org/​. Advantages Full integration into Android, so that almost all calendar and contacts apps can access synchronized data.  
- 
-===Integration via ExchangeActiveSync=== 
-<WRAP center round tip 60%> 
-The advantage is that you set the Url/​Username/​Password only in one location 
-</​WRAP>​ 
- 
-===Step-by-step configuration=== 
- 
-  * Open the account menu, choose add an exchange account 
-  * Fill your full email address and password in Account Setup page: 
-  * If it asks you to choose Account Type, please choose Exchange: 
-  * In detailed account setup page, fill up the form with your server address and email account credential 
- 
-    * Domain\Username:​ your full email address 
-    * Password: password of your email account 
-    * Server: your server name or IP address 
-    * Port: 443 
- 
-<WRAP center round todo 60%> 
-Please also check Use secure connection (SSL) and Accept all SSL certificates 
-</​WRAP>​ 
- 
- 
-  * In Account Settings page, you can choose Push. it's all up to you. 
-  * Choose a name for your Exchange account. 
-  * Click Next to finish account setup. That's all. 
- 
- 
- 
-====Mozilla Thunderbird and Lightning==== 
- 
- 
-Alternatively,​ you can access SOGo with a GroupDAV and a CalDAV client. A typical well-integrated setup is to use Mozilla Thunderbird and Mozilla Lightning along with Inverse’s SOGo Connector plug in to synchronize your address books and the Inverse’s SOGo Integrator plug in to provide a complete integration of the features of SOGo into Thunderbird and Lightning. Refer to the documentation of Thunderbird to configure an initial IMAP account pointing to your SOGo server and using the user name and password mentioned above. 
- 
-With the [[https://​sogo.nu/​download.html#/​frontends|SOGo Integrator plug in]], your calendars and address books will be automatically discovered when you login in Thunderbird. This plug in can also propagate specific extensions and default user settings among your site. However, be aware that in order to use the SOGo Integrator plug in, you will need to repackage it with specific modifications. Please refer to the documentation published online: 
- 
-http://​sogo.nu/​downloads/​documentation.html 
- 
-If you only use the SOGo Connector plug in, you can still easily access your data. 
- 
-  * To access your personal address book: 
-  * Choose Go > Address Book. 
-  * Choose File > New > Remote Address Book. 
-  * Enter a significant name for your calendar in the Name field. 
-  * Type the following URL in the URL field: http://​localhost/​SOGo/​dav/​jdoe/​Contacts/​personal/​ 
-  * Click on OK. 
- 
-To access your personal calendar: 
- 
-  * Choose Go > Calendar. 
-  * Choose Calendar > New Calendar. 
-  * Select On the Network and click on Continue. 
-  * Select CalDAV. 
-  * Type the following URL in the URL field: http://​localhost/​SOGo/​dav/​jdoe/​Calendar/​personal/​ 
-  * Click on Continue. 
-====Apple==== 
-<WRAP center round tip 60%> 
-FIXME, bring your knowledge 
-</​WRAP>​ 
- 
- 
-====Microsoft Mobile==== 
- 
-===ActiveSync=== 
-The following steps are required to configure Microsoft Exchange ActiveSync on a Windows Phone: 
- 
-Locate the Settings options from within your application menu. 
- 
-  * Select Email + Accounts. 
-  * Select Add an Account. 
-  * Select the option for Advanced Setup. 
-  * Enter your full email address and password for your account. Then press the sign in button. 
-  * Select Exchange ActiveSync. 
-  * Ensure your email address remains correct. 
-  * Leave the Domain field blank. 
-  * Enter the  address for Server (domain name or IP) 
-  * Select the sign in button. 
-  * You might need to accept all certificats,​ if you are not able to sync 
- 
-Once connected, you will see a new icon within your settings menu with the name of your new email account. 
- 
- 
-====Outlook==== 
- 
-you can use it with 
- 
-  * IMAP + commercial plugin as [[https://​www.cfos.de/​en/​cfos-outlook-dav/​cfos-outlook-dav.htm?​__ntrack_pv=1|cfos]] or [[http://​www.outlookdav.com/​|outlookdav]] for calendars/​contacts 
-  * ActiveSync since Outlook 2013 
- 
-no supports for Openchange/​OutlookMAPI 
- 
- 
-=====Nightly build===== 
-Sogo is built by the community, if you look to the last version, then you must use the nightly built. This version is not considered as stable, but bugs are fixed quicker than in stable version. You are the QA testers :) 
- 
-* NS7 sogo3 
- 
-<​file>​ 
- sudo rpm --import '​http://​pgp.mit.edu/​pks/​lookup?​op=get&​search=0xCB2D3A2AA0030E2C'​ 
-sudo rpm -ivh http://​dl.fedoraproject.org/​pub/​epel/​epel-release-latest-7.noarch.rpm 
-sudo cat >/​etc/​yum.repos.d/​SOGo.repo <<EOF 
-[sogo3] 
-name=SOGo Repository 
-baseurl=https://​packages.inverse.ca/​SOGo/​nightly/​3/​rhel/​7/​\$basearch 
-gpgcheck=1 
-EOF 
-</​file>​ 
-Then to install 
-<​file>​ 
-yum install nethserver-sogo --enablerepo=sogo3 
-</​file>​ 
- 
-* NS6 sogo2 
- 
-<​file>​ 
-sudo rpm --import '​http://​pgp.mit.edu/​pks/​lookup?​op=get&​search=0xCB2D3A2AA0030E2C'​ 
-sudo rpm -ivh http://​dl.fedoraproject.org/​pub/​epel/​epel-release-latest-6.noarch.rpm 
-perl -p0 -i -e '​s/​(\[epel\].*?​)\n\n/​$1\nexclude=gnustep-*\n\n/​s'​ /​etc/​yum.repos.d/​epel.repo 
-sudo cat >/​etc/​yum.repos.d/​SOGo.repo <<EOF 
-[sogo2] 
-name=SOGo Repository 
-baseurl=https://​packages.inverse.ca/​SOGo/​nightly/​2/​rhel/​6/​\$basearch 
-gpgcheck=1 
-EOF 
-</​file>​ 
- 
-Then to install 
-<​file>​ 
-yum install nethserver-sogo --enablerepo=sogo2 
-</​file>​ 
- 
-* NS6 sogo3 
- 
-<​file>​ 
-sudo rpm --import '​http://​pgp.mit.edu/​pks/​lookup?​op=get&​search=0xCB2D3A2AA0030E2C'​ 
-sudo rpm -ivh http://​dl.fedoraproject.org/​pub/​epel/​epel-release-latest-6.noarch.rpm 
-perl -p0 -i -e '​s/​(\[epel\].*?​)\n\n/​$1\nexclude=gnustep-*\n\n/​s'​ /​etc/​yum.repos.d/​epel.repo 
-sudo cat >/​etc/​yum.repos.d/​SOGo.repo <<EOF 
-[sogo3] 
-name=SOGo Repository 
-baseurl=https://​packages.inverse.ca/​SOGo/​nightly/​3/​rhel/​6/​\$basearch 
-gpgcheck=1 
-EOF 
-</​file>​ 
- 
-Then to install sogo for the first time 
-<​file>​ 
-yum install nethserver-sogo --enablerepo=sogo3 
-</​file>​ 
- 
-if you want to upgrade from sogo2 
- 
-<​file>​ 
-yum update ​ --enablerepo=sogo3 
-</​file>​ 
-===== Issues ===== 
- 
-Please raise Issues on [[http://​community.nethserver.org/​|discourse]] 
- 
-=====Sources===== 
-source are available https://​github.com/​NethServer/​nethserver-sogo 
- 
-documentation on [[https://​github.com/​NethServer/​nethserver-sogo/​blob/​master/​README.rst|github]] 
 {{tag>​module}} {{tag>​module}}