Home

Zarafa Collaboration Platform - The Administrator - NIT

1. Client Zarafa Server Node 2 Figure 6 4 Multiserver environment User John is located on Node 1 and the user Mary is located on Node 2 John has read access on the mailbox of Mary 1 John starts his Outlook client which connects to Node 1 2 The Zarafa Server Node 1 checks the Home Server attribute in the central LDAP server 3 The Home Server of user John is returned to the Zarafa Server 4 John s mailbox is located on Node 1 so the mailbox will be directly loaded 5 John sends a request to the Zarafa Server to open the mailbox of Mary 6 The Zarafa Server Node 1 checks the Home Server attribute of Mary in the central LDAP server 66 Prepare setup the LDAP server for multi server setup 7 8 9 The Home Server of user Mary is returned to the Zarafa Server A redirect request is send back to the client The client setup a connection to Node 2 to open the mailbox of Mary 6 3 2 Prepare setup the LDAP server for multi server setup The Zarafa multi server version can only be used with the LDAP user plugin In a multi server setup the Zarafa Server will not only request user and group information from the LDAP server but also information about the different multi server nodes will be requested 1 Setup the LDAP server using Section 5 2 Configure ZCP OpenLDAP integration or Section 5 3 Configure ZCP Active Directory integration in this manual Add in the LDAP structure a folder or or
2. LDAP server of choice optional for user management ZCP is tested with OpenLDAP eDirectory and Microsoft Active Directory Most of these dependencies are resolved automatically by the package manager of the linux distribution that ZCP is being installed on This allows the d party components used by ZCP to be installed and upgraded automatically through the package manager of the distribution Some dependencies in the table above are runtime dependencies these have to be installed manually as they do not necessarily have to run on the same machine The default method of deploying ZCP is installing the packages on one of the Linux distributions we support allowing the 3rd party components used by ZCP to be installed automatically through the package manager of the distribution In this case the a party components are upgraded in a standard way according to that distribution Chapter 2 Installing 2 2 Installation There are roughly 4 ways to install ZCP 1 through a distribution s package manager 2 using our install script 3 manually installing packages and 4 from source In this section each of these methods is explained along with its pros and cons Note In the community edition the package zarafa licensed is not needed though in order to have Outlook support in the community edition it is necessary to run the zarafa licensed daemon Note The Multi User Calendar inside the package zarafa webaccess muc is a
3. All Postfix configuration files can be found in etc post fix directory The main configuration file is logically called main cf http www postfix org LDAP README html 51 Chapter 5 Configure 3rd Party Components By default Postfix will only accept incoming emails from localhost To accept emails from the complete network configure the following option inet_interfaces all In order to make Postfix aware of the local emaildomains add the following line to the main cf virtual mailbox domains example com example org example net Postfix will now see the configured domains as it s local email domains however to accept incoming emails Postfix will do a recipient check This recipient check can be done on the Active Directory server Add the following lines to the main cf virtual mailbox maps ldap etc postfix ldap users cf virtual alias maps ldap etc postfix ldap aliases cf virtual transport lmtp localhost 2003 All incoming emails are delivered to the LMTP service of the zarafa dagent The delivery needs to be done on the primary mail address of a user For resolving the primary mail address of the user create the file etc postfix ldap users cf and add the following lines 192 168 0 100 ou Users dc example dc local server_host search_base version 3 bind yes bind_dn cn zarafa ou Users dc example dc local bind_pw secret scope sub query filter amp objectClass person mail s
4. result_attribute mail For lookups of mail aliases create the file etc postfix ldap aliases cf and add the following lines 192 168 0 100 ou Users dc example dc local server_host search_base version 3 bind yes bind_dn cn zarafa ou Users dc example dc local bind_pw secret scope sub query filter amp objectClass person otherMailbox s result attribute mail Active Directory has the possibility to create distribution groups which can be used as email distribution list in ZCP To use integrate Postfix with distribution groups Postfix 2 4 or higher is required Note Some linux distributions like RHEL 4 and 5 do not include Postfix 2 4 or higher Packages of newer versions of Postfix are usually available as omamy contributed packages In case of RHEL 4 and 5 these packages can be found 52 Configure ZCP Postfix integration with virtual users To support distribution groups add the following line to the virtual_alias_maps virtual_alias_maps ldap etc postfix ldap aliases cf ldap etc postfix ldap groups cf Create a new file etc postfix ldap group cf and insert the LDAP group configuration in there 192 168 0 100 ou groups dc example dc local server_host search_base version 3 bind yes bind_dn cn zarafa ou Users dc example dc local bind_pw secret query filter amp objectclass group mail s leaf_result_attribute mail special_result_attribute member The
5. show table status Check the data length column for the lob table This contains the number of bytes needed for the attachment storage To select this new storage method change the attachment storage option in the server cfg file and point the attachment path option to the folder where the attachments should be stored After changing this option zarafa server needs to be started once with the ignore attachment storage conflict parameter Advantages of attachments outside the database are MySQL does not save the large binary blobs in the database This improves the general read and write access Attachments will not cause cache purges of MySQL 23 Chapter 4 Configure ZCP Components Disadvantages of attachments outside the database are AMySQL dump of the database is not enough for a full recovery Remote storage of attachments requires a new system like folder mounted through NFS or Samba In most cases it is advisable to store attachments apart from the database especially in setups with more then 100 users N Important It is very important when choosing to store the attachments outside the database to update the backup strategy accordingly 4 2 4 SSL connections and certificates The Zarafa Server is capable of directly accepting encrypted SSL connections This feature may already be available when the HTTPS Apache server is setup to proxy these connections to the Zarafa Server However h
6. set the cell cache as high as can be managed usually about the same size as the MySQL buffer size 9 2 2 Zarafa s object cache cache object size The Zarafa object cache is used to cache the hierarchy table Each object that is accessed will be placed in this cache making it faster to retrieve the information again without accessing the database The more items users have in their folders the more important this cache becomes Since the information is quite small this cache does not need to be large About 1Mb for 10 users is even an overestimation 9 2 3 Zarafa s indexedobject cache cache indexedobject size To open a specific item the program needs to send the server a unique key called an entryid to the server to request that item This cache is a 2 way index of the MAPI key to a database key and the other way around The translation of the keys are quite important This cache is filled per folder so large folders will push out otherwise important information Normal usage is about 0 5 Mb per user 9 2 4 MySQL innodb buffer pool size The MySQL buffer is used to cache reads and writes to the ibdata file In a dedicated MySQL machine this would be anywhere between 50 to 80 of the physical RAM size in the machine When MySQL is run on the same machine as Zarafa it is recommended to be around 25 of physical RAM size so that Zarafa s Cell Cache can also be set to this value 9 2 5 MySQL innodb log file size The innodb log file
7. wiki zarafa com 9 1 Hardware Considerations There are also various different hardware setups to consider when setting up a server for Zarafa We will discuss the various types of hardware that affect performance 9 1 1 Memory usage Tuning memory usage is one of the best ways of increasing server performance as RAM is generally cheap using a large amount of RAM in the server properly can boost performance by orders of magnitude On the other hand setting RAM usage too high may cause the server to swap out parts of the memory which need to be swapped back in later causing a large slowdown in all parts of the server It is therefore important to set the RAM usage of various components to a high enough setting to use the RAM available and at the same time not to set the RAM usage too high To make use of the available RAM as best as possible Zarafa is designed to use only a fixed amount of physical RAM the memory usage does increase per user that connects but only by a small amount the largest part of the memory usage is due to cache settings in the configuration file This makes it very easy to control the exact amount of memory that will be used in a live situation and one can be pretty sure that the actual amount of RAM used will never go far beyond the values set So in general the optimum RAM usage is as high as possible without making the system needing to swap out important parts of available memory It is very diffi
8. 2 Configuring ZCP for OPENLDAP ssssssssssss eene ee enne nnne nnne nnne 41 5 2 3 User CONTIQUIAUION emet eee ettet eek Rx d ER Edd an Rei Re ELE 42 5 2 4 Group configuration scnasena pa daaa a adan aaa ak sens nns h shi entr sine aser aai nen 43 5 2 5 Addresslist configuration 0 0 cece ee cece ee ee ee ee eee e teeta tees ee ee santas meme nennen 43 5 2 6 Testing LDAP configuration 0cc cccceceeeee eect ce eeee ee eres eeeeaa eres ae ener 44 5 3 Configure ZCP Active Directory integration cccececeee cece ee eeee ee eeee ae eeeeeeeeaaeeeeaeeeeaeeeed 44 5 3 1 Installing the Zarafa ADS Plugin and schema files ccceeeeeeeceeeeeeeeeeeeeeees 44 5 3 2 Configuring ZCP TOF ADS ou e Re o bn e e ERR RR 47 5 3 3 User configuration ceci pee npa HERR A RRTE LE EHE NUER ERAT rr RAS ERARIIR 48 5 3 4 Group configuration 2 I Het Ite eee et e ida tbc kel aai Ee olg qe 48 5 3 5 Addresslist configuration sessssssssssseenem menn nennen 49 5 3 6 Testing Active Directory configuration esssssssseem HH 49 5 4 Z CP POStEX Integratlori stet ete dehet e ette E zu d ie Re epe aa anaaga RM RUE 50 5 4 1 Configure ZCP Postfix integration with OpenLDAP ssssesemH 50 5 4 2 Configure ZCP Postfix integration with Active Directory seseenees 51 5 4 3 Configure ZCP Postfix integration with virtual users sseeeeee 53
9. 5 5 Configure Z Push Remote ActiveSync for Mobile Devices sssseene 54 5 5 1 Compatibility rgsa et p e rear ERR EO CER UR ceaganes CHER ER FEAR A ET YRILAR E 55 5 525 Se Y TEE 55 5 573 InstallatiOn coii o ttti ATTE E E EUREN EE TEAT TE 55 5 5 4 Mobile Device Management sssssssessssem e mene mme nennen 56 5 5 5 Upgrade uite Er HR ERE etr RUNE EET SER suugagedse Pe PRAES Rer PEERS RAP Deep aA 57 5 5 66 Troubleshooting ee t tete ceder m Ute ee E et ee ee Gd 57 6 Advanced Configurations 59 6 1 Running ZCP components beyond localhost ssssssss em 59 6 2 Multi tenancy configurations sssssssssssseem eene enne nennen nennen 59 6 2 1 Support user plugins eee eee e eect i eee ee ee ii ea ee eee ee EENE ee eeaa essa eeesaaeesaaeees 60 6 2 2 Configuring the server ccc ceecce cece eeee ee ee ceca ence eee cate acne ee saee sede eeesaaeeaaeeesaaeeaaaees 60 6 2 3 Managing tenant company SPACES ce ceeeeeee cece eee eee e eect eene 63 6 2 4 Managing users and groups ceeeeeee ee eeee eee ee eeee em meme renis 63 6 2 5 Quota levels E T uelut oed EEST 64 6 3 Multi server setup cereri iicet oe ee eee ee aa a ee S ee ir teed thesi irse rh aidaa a S gnda 65 6 3 T IntfOQUCctlOr uei dee tc EU n eile uh tete idee du DR REPREHEN UE is 65 6 3 2 Prepare setup the LDAP server for multi server setup sssssesssesss 67
10. 6 1 4 1 26278 1 1 2 3 Integer Single Valued 112 zarafaSendAsPrivilege This attribute will contain users or groups that should have sendas permissions on a specific user Syntax DN or DirectoryString Multi or Single Valued Multi Valued zarafaMrAccept This attribute will configure auto acception of meeting requests This attribute is not used in the current Zarafa versions OID 1 3 6 1 4 1 26278 1 1 2 Syntax Integer Multi or Single Valued Single Valued zarafaMrDeclineConflict This attribute will decline meeting requests when the calendar contains already appointments This attribute is not used in the current Zarafa versions OID 1 3 6 1 4 1 26278 1 1 2 Syntax Integer Multi or Single Valued Single Valued zarafaMrDeclineRecurring This attribute will decline meeting requests when they are set as recurrent This attribute is not used in the current Zarafa versions OID 1 3 6 1 4 1 26278 1 1 2 Syntax Integer Multi or Single Valued Single Valued zarafald This attribute can be used a generic unique id for example users and groups This attribute is default not used by Zarafa OID 1 3 6 1 4 1 26278 1 1 2 Syntax Integer Multi or Single Valued Single Valued zarafaResourceType This attribute will configure the resource type of a shared store The available options are Room or Equipment OID 1 3 6 1 4 1 26278 1 1
11. File as amp Display Name 75 Aafke Aafke Test German DU T NNI nia e Aaltje Aaltje Test Contacts Marisa Test Abel Abel Test Abel rotterdam unt 3 Abigail Abigail Test Abiaailicorotterdam u Figure 5 1 Addresslists in Global Adress Book Change or add in 1dap cfg the following configuration settings for the addresslist objects ldap addresslist search filter ldap addresslist unique attribute gidNumber 43 Chapter 5 Configure 3rd Party Components ldap addresslist unique attribute type text ldap addresslist filter attribute zarafaFilter ldap addresslist name attribute cn See Section 8 8 Address lists by condition for more information on how to administer address lists 5 2 6 Testing LDAP configuration After the LDAP configuration is done the changes can be activated by reloading the Zarafa Server etc init d zarafa server reload To test whether users and groups will be listed correctly using the LDAP configuration use zarafa admin 1 for users and for groups zarafa admin L If no users or groups are shown please check the Zarafa server log file for errors Setting the log levelto 6 in the etc zarafa server cfg will display all LDAP queries send to the server and possible errors Note The first time the zarafa admin 1 is done all mailboxes will be created This can take some time so be patient More information about other available LDAP attributes can be found in the
12. H z Indexer H Active MTA Webserver with PHP BlackBerry Directory usually Postfix usually Apache Enterprise Zarafa Server m MySQL File system attachments Figure 1 1 Zarafa Collaboration Suite Architecture Diagram Components 1 3 Components Installations of the Zarafa Collaboration Platform ZCP may consist of the following components Zarafa Server Zarafa server The server process accepts connections for all clients through SOAP HTTP and stores the data in an SQL database Zarafa License Manager zarafa licensed The licensed process checks which features will be available dependent on the license chosen for the Community Standard Professional or Enterprise edition Zarafa Windows Client The Zarafa client provides access to Outlook through an interface known as MAPI The connections with the server are handled by SOAP Zarafa WebAccess zarafa webaccess A full featured web interface with an Outlook look and feel that enables users to collaborate from any computer with an internet connection Zarafa Delivery Agent and Zarafa Spooler zarafa dagent zarafa spooler The tools which serve the email communication with the outside world The dagent delivers mail from the Mail Transport Agent MTA to a Zarafa user The spooler sends mail waiting in the outgoing queue to the specified MTA Zarafa Admin zarafa admin The command line administration tool is used to manage us
13. ID stated above is therefore a reference to a user ID within the Zarafa database This ID is stored in the users table along with a reference to the ID of the user in the external user database in this case an LDAP server For example user A may have user ID 5 in the Zarafa system and may refer to the item dn cn user dc domain dc com on the LDAP server Keeping a list of users in this way also solves the problem of creating the store for a user There is no way to trigger a store creation event on the Zarafa server whenever a user is added in the LDAP server The users table provides a convenient way to track which users are new to the system and therefore require a new store The same goes for deleting users as the user store needs to be removed when the user is deleted So the users table in Zarafa is almost exclusively a mapping between the user ID which is used internally in Zarafa and an external reference to a user in the LDAP database Naturally when any new users are added or users are removed from the LDAP server this table must be kept in sync with the changes There are many ways of keeping the users table synchronised with the LDAP server but Zarafa has chosen for a just in time approach This means that any time a user is requested from the system it is first checked in the LDAP server for existence and then it is checked in the users table for existence If the user does not ex
14. Zarafa Gateway IMAP and 4 6 4 SSU TLS iua uen 4 6 2 Important notes 4 7 Configure Zarafa Quota Manager 4 7 1 Setup server wide quota 4 7 2 Setup quota per user 4 7 3 Monitoring for quota exceeding ile MM E Zarafa Collaboration Platform 4 7 4 Quota warning templates ccccececeeeee cece ee ee esse eres ae essa me nere nnns 33 4 8 Configure Zarafa Indexer 0 0 cece cece cece ce ee cece teeta ence ee cate ee nennen nennen neni h nennen nnne 33 4 8 1 Enabling indexing service ssssssssssseem mmm ennemis 33 4 8 2 Users companies and servers ssssssssssssee mene mene enne nnns 34 4 8 3 Indexer configuration sssssssssssse emen mene nemen ren enn nn nns 34 4 8 4 CLUCENE configurati ri iue Lt P et bec dev ede eed eid vede Sla eda 35 4 8 5 Attachiments 31 ene e ood ten e ica e Een ae 37 5 Configure 3rd Party Components 39 5 1 Contigure the WebServer ouo ed ed tere Pb dere edite pa denn 39 5 141 Configure PHP nirre ieii etn SER ERARR E ERES ERR ERAE e EEG HR PRARI eO E YER iR ERR 39 5 12 configure Apache ertet ted eee rte de bti da eek tee bet ad ve ed 39 5 1 3 Apache as a HTTP Proxy ite ie Here te Re Le ERE RE E ERR LER RRAR 40 5 2 Configure ZCP OpenLDAP integration sssssssseem emer 40 5 2 1 Configuring OpenLDAP to use Zarafa schemas ssssssssese 41 5 2
15. are found in the gateway The defaults for the ssl private file key and ssl certificate file have been changed The default directory is now etc zarafa gateway to distinguish it from the service ssl files 110 Chapter 12 Appendix B LDAP attribute description This appendix will describe all available LDAP attributes available in the Zarafa schema The Zarafa schema is available in the Active Directory integration toolkit and in the directory usr share doc zarafa Please keep in mind that the Zarafa LDAP configuration files are very flexible so these attributes are not in all cases used zarafaQuotaOverride This attribute is used to override the default quota which configured in the etc zarafa server cfg This attribute always need to enabled to use a custom quota setting OID 1 3 6 1 4 1 26278 1 1 1 Syntax Integer Multi or Single Valued Single Valued zarafaQuotaWarn This attribute contains the warning quota level in Mb OID 1 3 6 1 4 1 26278 1 1 1 Syntax Integer Multi or Single Valued Single Valued zarafaQuotaSoft This attribute contains the soft quota level in Mb OID 1 3 6 1 4 1 26278 1 1 1 Syntax Integer Multi or Single Valued Single Valued zarafaQuotaHard This attribute contains the hard quota level in Mb Syntax Integer Multi or Single Valued Single Valued zarafaUserDefaultQuotaOverride This attribute will ov
16. attribute will contain users from different companies which are administrator over selected company 1 3 6 1 4 1 26278 1 3 2 5 DirectoryString Multi or Single Valued Multi Valued zarafaSystemAdmin This attribute will specify the user who is the system administrator for this company OID Syntax Multi or Single Valued 1 3 6 1 4 1 26278 1 3 2 Integer Single Valued zarafaQuotaUserWarningRecipients This attribute will contain users who will receive a notification email when a user exceeds his quota Syntax DirectoryString Multi or Single Valued zarafaQuotaCompanyWarningRecipients Multi Valued This attribute will contain email address who will receive a notification email when a company exceeds his quota OID 1 3 6 1 4 1 26278 1 3 1 Syntax Multi or Single Valued DirectoryString Multi Valued zarafaCompanyServer This attribute will contain the home server of a company when running in multi server mode OID Syntax Multi or Single Valued 1 3 6 1 4 1 26278 1 3 4 DirectoryString Single Valued zarafaHttpPort This attribute will contain the port for the http connections when running in multi server mode 115 Chapter 12 Appendix B LDAP attribute description OID 1 3 6 1 4 1 26278 1 4 4 1 Syntax Multi or Single Valued Integer Single Valued zarafaSslPort This attribute w
17. browsers are known to simply work with the Zarafa WebAccess Starting from ZCP 7 0 we plan to add Google Chrome and Apple Safari to the list of officially supported browsers Our next generation WebAccess of which a beta will be part of ZCP 7 0 0 will not support IE6 Note Two Firefox add ons are available on the ox Add ons we The first adds drag and drop functionality and is PO by Zarafa itself The second add on features a new mail indicator to Firefox Supported Microsoft Outlook versions Our Zarafa Windows Client is officially compatible with Outlook 2000 2002 XP 2003 and 2007 We recommend Outlook 2003 and 2007 Note Outlook 2010 32bit support beta is expected soon 2 1 3 Dependencies In order to build or install ZCP back end components a bunch or requirements have to be met These are the main dependencies of ZCP MySQL without MySQL the Zarafa Server cannot run No need to run on the same machine as the Zarafa Server therefor not a package dependency MySQL version 4 0 or lower will not work correctly ZCP is tested with MySQL 4 1 5 0 and 5 1 Apache or any other webserver that supports PHP ZCP is tested with Apache 2 0 and 2 2 PHP standalone as CGI or preferably as a webserver module ZCP is tested with PHP 4 3 x and the latest 5 x release Catdoc and Poppler utils for indexing text documents and pdf s files SMTP server of choice ZCP is tested with Postfix Sendmail and Qmail
18. can be performed by the user itself This is because the softdelete system is accessable through Outlook When older messages are requested to be restored the Administrator will need to consult the backups It is not possible to restore a single item with a MySQL dump so this is the point where the zarafa backup tool steps in The bricklevel backups from the zarafa backup tool contain not enough information for disaster recovery A complete dump of the MySQL database will be needed to perform this type of recovery 10 2 Full database dump All the data that is stored by Zarafa Server is stored within a MySQL database This means that for a disaster recovery all that is needed is a full backup restore of the database in question This can be 103 Chapter 10 Backup amp Restore done in many ways but we will explain two ways of doing a good backup here Also there are some ways not to do a backup 10 2 1 SQL dump through mysqldump The contents of an entire Zarafa database can be saved to a file by using the mysqldump command There are however some options that are important in this case the single transaction option should always be specified to mysqldump When this is done it will cause mysqldump to write a single snapshot of the database to disk This will make sure that any writes done in the database during the backup will not be backed up In effect the dump that is made is a snapshot of the database at the mom
19. contain mail such as Drafts and Deleted Items All sub folders are shown as in Microsoft Office Outlook or the Zarafa WebAccess The Zarafa IMAP amp POP3 Gateway can be configured with a configuration file The configuration options are 29 Chapter 4 Configure ZCP Components server_bind IP address to bind to 0 0 0 0 for any address Default value 0 0 0 0 imap_enable Enable IMAP service with value yes Default value yes imap_port The IMAP service will listen on this port for incoming connections Default Value 143 imaps_enable Enable secure IMAP service with value yes Default value no imaps_port The secure IMAP service will listen on this port for incoming connections Default value 993 pop3_enable Enable POP3 service with value yes Default value yes pop3_port The POP3 service will listen on this port for incoming connections Default value 110 pop3s_enable Enable secure POP3 service with value yes Default value no pop3s_port The secure POP3 service will listen on this port for incoming connections Default value 995 imap only mailfolders Enable only mailfolders to be shown with value yes Default value yes server socket The http address of the Zarafa server Default value http localhost 236 zarafa Important It is not advised to specify the UNIX socket here In default configuration the Zarafa Gateway will then be trusted by the zarafa server as set in its local admin users configuration
20. dependencies try to install packages for these dependencies as normal would be done for that distribution yum i on Red Hat yast i on OpenSUSE SLES 2 2 3 2 DEB based distributions On DEB based distributions most commonly Debian and Ubuntu use dpkg i lt package file gt 11 Chapter 2 Installing To install the correct dependencies for ZCP apt get or an equivalent tool can be used For MySQL use apt get install mysql server 5 0 libmysqlclientib5off For Apache with the needed PHP support use apt get install apache2 mpm prefork libapache2 mod php5 If the Zarafa packages fail to install because of dependencies please use the following command to install these dependencies apt get f install If Apache with PHP support is installed after the Zarafa packages have been install please use the following command to automatically update PHP configuration dpkg reconfigure zarafa 2 2 3 3 Installing from Source ZCP is not officially supported by Zarafa when build from source yet in some situations i e using ZCP on unsupported environments or when preparing patches for ZCP it is very useful to install from source Since most of ZCP is distributed under an open source license AGPLv3 it is in one s right to build ZCP from source How to exactly install ZCP from source is beyond the scope of this document The procedure is also slightly different for each distribution and subject to change Please have a
21. epa s 84 4 3 Soft Delete System nre ERR ERR ERE ERE changeacaae isdeeess EIRE EEA 84 8 User Management 87 9E Public SOE fori alas tires tates hand d ER e dv ia Loeb De LED i 87 9 25 USETS nane tutae enter seee exta eon loea deett a der Ken is set ined ere eue see euet Pu Kei gd 87 9 241 Creating sers cine Ae i rez ere eund avere god eee arg rore Ede De Tee kane dna 87 8 2 2 Non actlve USers Ween secre det b tete e E asker dit AR t head x LERRA DUE 88 8 2 3 Updating stores and user information sss 88 8 2 4 Deleting USE S i n eise e e i tie deter b ete fepe s 88 8 2 5 Send as PermissiOns s iin iei do rede rd e uty bees ed ero 89 8 3 GROUPS iet eet ee eode a te oet aa ved eod ie edet god dde te edet vue scab Ee baee se udo Reng 90 8 3 1 Creating groups using zarafa admin sssessseee 90 8 4 Other admin commands dace Daten extent e De tee tinal 90 8 5 User Management with LDAP or Active Directory sssssm Hm 91 8 5 1 The Zarafa user synchronization principle ssse 91 8 5 2 Add Remove events en ee deu ee ace e LL Re RUMP EAR TR ER AAA EUA d 92 8 5 3 Group memberships iii net Ee e Eee Ere e E a ae HER aeta 92 8 5 4 LDAP server dependengy ssssssssssseee mene mener nnne 92 8 5 5 Setting up the LDAP repository sssssemm eee 93 8 6 Send as Permissions option sssssssssssssee mene mee nen nnne nnne nnne 93 8 7 Hi
22. feature not available in the community edition A valid subscription is needed Note The shared libraries which provide the user plugin are installed in usr 1ib64 zarafa instead of the usr lib zarafa location This path has to be adjusted in the server cfg configuration file Set the plugin_path to usr lib64 zarafa so the server can find the user plugin files 2 2 1 Installing ZCP with a Package Manager ZCP is found in the Canonical Partner Repository for the Ubuntu distribution This means ZCP can be installed and updated on Ubuntu currently only the 8 04 LTS release with the distribution s package manager On Ubuntu 8 04 LTS the Canonical Partner Repository has to be uncommented in etc apt sources list 2 2 2 Installing with the Install Script When downloading ZCP from the hitp www zarafa com website either the community edition or a commercial edition a tarball is presented containing the following the packages RPMs or DEBs depending on the distribution the install sh and uninstall sh scripts and an additional helpers inc file a folder named win32 containing Windows specific binaries The install sh script will automatically execute the actions described under Manual Installation below Thus it will check package dependencies install packages check MySQL database access 10 Manually Installing Packages ask for configuration options The installation script is invoked
23. filters may be emptied since they are double It still is advisable use zarafaAccount in the user filter so the options are still available To protect the server from deleting users a safe mode option is available in the server cfg Enabling this option will disable all delete and create actions of users and groups Add the following option in the etc zarafa server cfg to enable safe mode user safe mode yes Check the server logfile after starting the Zarafa Server for detection of user changes If no users are recreated or deleted the configuration file is correct and user safe mode can safely be disabled Note If safe mode is enabled it is possible that users don t have access to public folder Please disable safe mode if this is the case 3 4 Finalizing the upgrade After checked the new configuration options have been checked the services can be started again etc init d zarafa server start etc init d zarafa spooler start etc init d zarafa licensed start The optional services can also be started again etc init d zarafa dagent start etc init d zarafa gateway start etc init d zarafa ical start etc init d zarafa indexer start etc init d zarafa monitor start Note In the community edition the package zarafa licensed is not needed though in order to have Outlook support in the community edition the zarafa licensed daemon has to run 17 Chapter 3 Upgrading Since upgrades usually inclu
24. in Microsoft Outlook do not work using the Zarafa IMAP amp POP3 Gateway Some clients can set rules but these rules are not related to the rules set by a MAPI enabled client Deleting a mail using IMAP will mark the mail for deletion This is not shown in Microsoft Outlook and Zarafa WebAccess The mail will be deleted when the client expunges the folder Some clients allow to expunge folders manually and some have settings when to expunge a folder Other clients expunge the folder automatically when a mail is deleted Moving mail to a different folder with IMAP is done by copying the mail to the new folder and mark the originating mail for deletion As long as the the original mail is not expunged from its folder the mail will be shown in both folders as stated above 4 7 Configure Zarafa Quota Manager Users can collect a lot of email while disk space can be limited The Zarafa Quota Manager can be used to set server wide or user specific space quotas The Zarafa Quota Manager knows three levels 31 Chapter 4 Configure ZCP Components warn soft and hard quota When one of the levels will be reached the user receives an email with the quota sizes and which quota level was reached The quota settings can be configured server wide in the server cfg or per user via the user plugin When a user reaches the warning quota level the user will receive an email with a warning and quota information As the user reaches the soft quota
25. it possible to integrate Zarafa into an existing environment Various LDAP server systems are supported and Zarafa will communicate with any standard LDAP protocol version 3 or later server This means that Zarafa works in combination with industry standard solutions as Microsoft Active Directory OpenLDAP and eDirectory This document describes loosely how Zarafa uses the LDAP server as a source for user group contact and company information In most cases the particular setup used will require other options and settings than those described in this document It is therefore assumed that the reader has a good understanding of how LDAP trees work and how they are configured in their network For more information please refer to the example configurations and manual pages available on all systems on which Zarafa is installed 8 5 1 The Zarafa user synchronization principle In any Zarafa server there is a database holding the actual data needed while running Zarafa Apart from the actual folder and item data the database also holds information on data access rights user settings and user meta data set for users and groups A lot of this data refers to a specific user ID For example an ACL Access Control List for the inbox for user A will be stores in the database as a record in the ACL table This record holds the actual access rights for the objects and the user ID to whom the access control entry has been assigned The user
26. look at our wiki search for from source for the latest information regarding installation from source 2 3 Troubleshooting Installation Issues 2 3 1 Server processes Make sure at least MySQL 4 1 is installed The server will only run with this version of the database Server or a more recent version If errors when loading libraries occur or connecting to MySQL fails the errors are printed in the log Always check if the service was started correctly When an invalid configuration option is present in a configuration file the service will not start The wrong options will be printed on the console 2 3 2 WebAccess To correctly see the WebAccess the following PHP extensions are needed e gettext 7 http wiki zarafa com 12 WebAccess session e iconv e xml Some distributions deliver support for these extension by default through the PHP package For SUSE distributions these modules are provided by separate RPMs eg php5 gettext 5 2 8 37 4 x86_64 rpm php5 iconv 5 2 8 37 4 x86_64 rpm Versions may differ for newer versions of SUSE For Red Hat Enterprise Linux and Debian distributions these modules are provided by the normal php package which was already installed because of dependencies If experiencing problems with sending attachments make sure the webserver is able to create files under the WebAccess tmp directory If a user is directly logged off when he tries to login to the WebAccess make sur
27. man zarafa ldap cfg 6 2 2 5 Public stores Once the server has been correctly started stores can be created There are two type of stores Private and public stores There can only be one public store per company space When creating a company the public store will be created simultaneously If for some reason the public store for the specific company is not created the public store can be created manually by executing the following command usr bin zarafa admin s I tenant Replace tenant with the name of the tenant company for which the public store should be created When the I option is not used the public folder will be created for a single tenancy environment And will not be accessible when multi tenancy Zarafa is enabled The public folder is by default available for all users within a tenant company 62 Managing tenant company spaces 6 2 3 Managing tenant Company spaces Note Management of tenant company spaces through zarafa admin is only available when using the DB plugin When the LDAP plugin is used all administration needs to be done through the LDAP or Active Directory server To create a company space use the following command usr bin zarafa admin create company lt companyname gt To delete a company space use the following command usr bin zarafa admin delete company lt companyname gt To change a company space use the following command usr bin zarafa admin se
28. no create home ingroup zarafa disabled password gecos Zarafa services shell bin false zarafa mkdir var log zarafa chown zarafa zarafa var log zarafa Note The addgroup and adduser tools may have different syntax on different distributions Edit the run as user and run as group options in the server cfg file and set them both to zarafa Make sure the local admin users option still contains root as an administrative user so the zarafa admin tool can still be used Otherwise su or sudo has to be used each time the zarafa admin tool is started 6 6 Single Instance Attachment Storage Since ZCP 6 30 the Zarafa Server provides Single Instance Attachment Storage to avoid redundant storage of attachments This feature as its name implies only keeps one copy of each attachment when a message is sent to multiple recipients within the same server This mechanism thus minimizes the disk space requirements and remarkably enhances delivery efficiency when messages with attachments sent to large distribution lists Let s assume the following situation user A belongs to a Zarafa server he sends a message with 10 MB of attachments to 30 users that reside on the same server In a normal situation 30 copies of the files would be saved on the database leading to an inefficient usage of the storage space 310 MB of data With single instance attachment store only one copy of each attachment is saved on the database only 10 MB o
29. parsing of a single attachment can be restricted by limiting the total memory and CPU time usage To control the maximum amount of memory the script can use is controlled by the configuration option index attachment parser max memory By default this value is set to 0 to disable any memory consumption restriction If a restriction should be applied the maximum number of bytes should be provided The best restriction size depends on the maximum attachment size which can be provided 37 Chapter 4 Configure ZCP Components to the script configured using index_attachment_max_size and the 3m party tools used to parse the attachments To prevent the script to take too much time the configuration option index attachment parser max cputime can be used By default this value is set to 0 to disable any CPU time restriction If a restriction should be applied the maximum number of seconds should be provided The best restriction depends on the 3 party tools used to parse the attachments If either of these limits is exceeded the script will be canceled and the attachment will not be indexed Note The zarafa indexer will utilize the Single Instance Attachments feature and keep parsed attachments in its cache This will reduce the required indexing time for attachment which have been delivered to multiple users on the same server The lifetime of this cache is controlled by the index cache timeout configuration option discussed earlie
30. password something goes wrong and it should be killed with Ctrl C When all goes well the following line is printed to the screen Joined LINUXSERVER to realm ADSDOMAIN LOCAL or some other success message Now it s required to restart the winbind daemon because it keeps too many items cached etc init d winbind restart And that s it To test if authentication actually worked try the following command ntlm auth username john Where john is a user on the ADS server The program will asks for a password After entering the password it should say NT STATUS OK Success 0x0 If this step does not work try restarting winbind check the DNS names check with strace what ntlm auth tries to do check with tcpdump if there is actual traffic on the network from nt1m auth to the domain server and other lowlevel debugging tools 6 7 2 NTLM SSO with Samba 6 7 2 1 Installing Linux software The following software needs to be installed on the ZCP server winbind Depending on the Linux distribution used this comes through various package names On Debian use apt get install winbind On Red Hat Enterprise Linux the samba common package is required for this To enable NTLM SSO with ZCP set the following in the etc zarafa server cfg file enable sso ntlmauth yes 6 7 2 2 Joining the domain Now the server need to join the Samba domain by executing the following command 78 SSO with Kerberos net rpc j
31. port The secure service will listen on this port for incoming connections Default value 8443 server socket The http address of the Zarafa Server Default value http localhost 236 zarafa Important It is not advised to specify the UNIX socket here In default configuration the Zarafa Caldav will then be trusted by the zarafa server as set in its local admin users configuration setting Unless Zarafa Caldav is specified to run as an untrusted user it always authenticates users even if they provide no or wrong credentials ssl private key file 27 Chapter 4 Configure ZCP Components The file that contains the private key used for encrypting the ssl connections The absolute path to the file should be used Default value etc zarafa privkey pem ssl certificate file The file that contains the certificate for the server The absolute path to the file should be used Default value etc zarafa cert pem ssl verify client Enable client certificate verification with value yes Default value no ssl verify file ssl verify path The file or path to the files to verify the clients certificate with The absolute path should be used for both options no default 1ogging The Caldav component has the same configuration options as the server to configure logging options 4 5 1 SSLITLS As mentioned before the Zarafa Caldav component supports SSL TLS for this the OpenSSL library is used The private key for en
32. search base of users aliases and groups need to match the search base of the Active Directory server After the configuration files have been changed Postfix need to be restarted etc init d postfix restart Make sure the zarafa dagent is run as a daemon and started at boot time chkconfig zarafa dagent on etc init d zarafa dagent start Note It is advised to enable logging of the zarafa dagent when running in LMTP mode for monitoring purposes Enable the logging options in the zarafa dagent in etc zarafa dagent cfg 5 4 3 Configure ZCP Postfix integration with virtual users If no OpenLDAP or Active Directory Server is available Postfix can be configured with virtual users in a hash map In this section we explain how By default Postfix will only accept incoming emails from localhost To accept emails from the complete network configure the following option inet interfaces all All Postfix configuration files can be found in etc post fix directory The main configuration file is logically called main cf In order to make Postfix aware of the local email domains add the following line to the main cf virtual mailbox domains example com example org example net Postfix will now regard these domains as it s local email domains In order to accept incoming emails Postfix will also need to validate the recipient Add the following lines to the main cf config file in order to have Postfix look up recipient from a hash
33. servers ssssssssssese 102 10 Backup amp Restore 103 10 1 Softdelete cache sa sept ded oerte te Ren pua Dei de a Rye t Re e DRAR 103 10 2 Full database dump rri ti ode ERE ERRER EE vere deus Ee Regan 103 10 2 1 SQL dump through mysqldump sssssseeenm Hem 104 10 2 2 Binary data dump via LVM Snapshotting sesssssseeemm 104 10 2 3 Attachments backup tirato er E dee ben alseipi ain 104 10 3 Brick level backups oriri reete Peine rna Re ERR EE Ee ein Fe aR A 104 10 3 1 Backup fOImat dott et eed e art etd d Gee Ee aed pes cate ve tud 105 10 3 2 Backup PIOCESS eise err ea ta sae re ERR oh ance ER Ee sense Ue Need e abe AESA aT 105 10 3 3 Restore DIOCGSS iorn etia o ORC Hen ee A EE od ER ED De So EE 106 11 Appendix A Pre 5 2x upgrade strategies 109 11 1 Database upgrades from 4 1 or 4 2 ssssssssssssssss eem nnne 109 11 2 Upgrades from 5 0 to 5 1x and up ssssssssseem meme renes 110 11 3 Important changes since 4 x and 5 x sssssssssssssee mene mene enne nnns 110 12 Appendix B LDAP attribute description 111 vi Chapter 1 Introduction The Zarafa Collaboration Platform ZCP is an open source software suite capable of replacing Microsoft Exchange It s architecture is very modular makes use of standards wherever possible and integrates with common open source components This document explains how to perform the most com
34. setting Unless Zarafa Gateway is specified to run as an untrusted user it always authenticates users even if they provide no or wrong credentials 30 SSL TLS ssl_private_key_file The file that contains the private key used for encrypting the ssl connections The absolute path to the file should be used Default value etc zarafa privkey pem ssl certificate file The file that contains the certificate for the server The absolute path to the file should be used Default value etc zarafa cert pem ssl verify client Enable client certificate verification with value yes Default value no ssl verify file ssl verify path The file or path to the files to verify the clients certificate with The absolute path should be used for both options no default logging The gateway has the same configuration options as the server to configure logging options 4 6 1 SSLITLS The Zarafa Gateway supports SSL TLS using the OpenSSL library For more information see Section 4 5 1 SSL TLS as the options are exactly the same for these two components 4 6 2 Important notes IMAP and POP3 are provided for backward compatibility and will not provide the same experience like clients that support MAPI Microsoft Outlook or our WebAccess IMAP POP3 clients use these protocols for mails only where MAPI does mail calendar and contacts Setting the Out of Office message is not possible with IMAP or POP3 clients Rules set
35. size is the size of the transaction log By default there are two logfiles The preferred value size for the innodb log file size is 25 ofthe innodb buffer pool size 101 Chapter 9 Performance Tuning 9 2 6 MySQL innodb log buffer size The size of the innodb log buffer size that InnoDB uses to write to the log files on disk A large log buffer allows large transactions to run without a need to write the log to disk before the transactions commit If big transactions are present making the log buffer larger will save disk I O This value should be 2596 of the innodb log file size 9 2 7 MySQL query cache size The MySQL query cache is normally disabled Enabling the query cache can cause a small performance increase but increasing it to more than a few MBs is not necessary as most recurring SQL queries are rather small 9 2 8 Setup of modules on different servers There are several parts of the Zarafa server that can be hosted on different servers In fact almost each part of the server can be run on a different system However in practice splitting all modules of the server on the different servers will not increase performance The main parts that should be considered are Server1 MySQL server ServerZ Zarafa server Server3 MTA AntiSpam AntiVirus Server4 WebServer If these 4 parts were to be hosted on 4 servers each server would communicate with the others to work as a single system This setup can be
36. soft limit for the user or company ZARAFA QUOTA HARD SIZE The quota hard limit for the user or company Note Variables containing a size always include the size unit B KB MB GB as part of the variable 4 8 Configure Zarafa Indexer The zarafa indexer service introduced in ZCP 6 40 offers full text searching capabilities for the Zarafa Server The service will periodically index all mails and optionally their attachments from the server When searching for a particular mail the required time to find the requested emails will be seriously reduced When attachment indexing is enabled it is even possible to index the contents of attached files for common file types 4 8 1 Enabling indexing service To start the indexing service execute the following command 33 Chapter 4 Configure ZCP Components etc init d zarafa indexer start To enable the full text searching edit the etc zarafa server cfg configuration file index_services_enabled yes During searching the zarafa server will connect with the zarafa indexer service To set the connection path change the following configuration option index services path file var run zarafa indexer 4 8 2 Users companies and servers By default the indexing service will index the mail from all users in all companies on all Zarafa servers within the Zarafa environment To disable the indexing of mails from specific users the following configuration options in etc
37. support two kinds of send delegation Send on Behalf permissions If a user grants the appropriate permission to another user the latter can send items on behalf of the other user In this case an email or meeting request will be sent with the following from field delegate on behalf of user This setting can only be set from the WebAccess or Outlook client Send As permissions If the system administrator gives the rights to user B to send as user A the receiver of an email will not see that user B sent an email The receiver will only see user A in the from field Before version 6 20 a user could use only the send on behalf of permissions This meant letting a user send an email on behalf of another user from inside the inbox of the other user It was always possible to see who sent the email For example Pete enters the inbox of info and sends an email as the non active user info petegexample com on behalf of infoQexample com would be displayed Since 6 20 it is possible to send emails as other users without the on behalf of part Due to security reasons the new send as permission is only configurable by the administrator on the server side This setting can always be overruled by the user itself and the old on behalf of permission can still be set by the user See the user manual on how to set the user based on behalf of delegation and or overruling of the admin based send as delegation S
38. the client certificates can be created by the following steps cd etc zarafa ssl sh usr share doc zarafa ssl certificates sh client 69 Chapter 6 Advanced Configurations 10 11 12 13 14 Fill in all the information like the server certificate On some linux distributions the Common Name may not be the same as in the server certificate At the end of the creation it s required to sign again the certificate against the CA and create a public key for the certificate Two client certificates are created client pem and client public pem The client pem is the private key and will be used by a client like dagent or spooler The client public pem is the public key which is used by the server Move the public key to the etc zarafa sslkeys directory mv etc zarafa ssl client public pem etc zarafa sslkeys Restart the zarafa server on all nodes to activate the new certificates etc init d zarafa server restart To test the client SSL certificates change the following lines in the etc zarafa dagent cfg server socket https 127 0 0 1 237 zarafa sslkey file etc zarafa ssl client pem sslkey pass lt ssl client password gt When the certificates have been set up email can now be delivered by using the ssl socket with the dagent s private key in this test case on localhost zarafa dagent v c etc zarafa dagent cfg username on this node Subject test email Test lt ctrl d gt When conn
39. therefore either join the domain using the ADSDOMAIN or ADSDOMAIN LOCAL name FQDN of the Linux server is LINUXSERVER LOCAL This name does not matter much as long as it is handled by the DNS server 6 7 1 3 Configuring the Kerberos library First we are going to configure the Kerberos library The configuration file is etc krb5 conf Under the libdefaults section set default realm ADSDOMAIN LOCAL Under the realms section add the windows realm realms ADSDOMAIN LOCAL kdc 192 168 0 1 admin_server 192 168 0 1 password_server 192 168 0 1 default_domain ADSDOMAIN LOCAL Here 192 168 0 1 is the IP address of the Windows ADS domain server Now that the Kerberos library is configured it is possible to login using kinit on the linux server kinit Administrator This will ask for a password Password of Administrator ADSDOMAIN LOCAL Type the administrator password there and a Kerberos ticket should be provided by the ADS server 6 7 1 4 Joining the ADS domain First we ll configure samba Edit the etc samba smb conf file and add set the following options global realm ADSDOMAIN LOCAL use kerberos keytab true security ads 77 Chapter 6 Advanced Configurations With this ticket we can join the Windows domain without typing the password again net ads join S ADSDOMAIN U Administrator This command may also be different for different versions of Samba If this command asks for a
40. user s calendar user gt http server 8080 caldav lt user gt user s self created calendar in user s own lt calendar gt store http server 8080 caldav lt user gt user s self created subcalendar in a self lt calendar gt lt subcal gt created calendar http server 8080 caldav public Calendar folder in the public folder lt calendar gt Table 4 1 CALDAV and iCal URLs URL For MAC OSx iCal client Calendar http server 8080 caldav User s calendar list http server 8080 caldav lt other Other users calendar list user gt http server 8080 caldav public Public folders list Table 4 2 CALDAV and iCal URLs for MAC OSX iCal client Note The other user or user calendar is only reachable if the correct permissions are available Note The Mac OS X iCal client is fully tested and supported up to 10 5 6 Additional information regarding client side setup is can be found in the Zarafa User Manual 4 6 Configure Zarafa Gateway IMAP and POP3 The Zarafa IMAP amp POP3 Gateway enables users to view mail stored on the Zarafa Server with an IMAP or POP3 client For example Mozilla Thunderbird or a mobile device with Microsoft Pocket Outlook To access the user data the Zarafa Gateway itself connects to the Zarafa Server with MAPI POPS can only retrieve the mail in the Inbox from the server IMAP on the other hand displays all folders that can
41. various clients Microsoft Outlook does not need any special infrastructure but communicates directly with the Zarafa Server using the Zarafa Windows Client The Zarafa Server is basically serving MAPI calls while storing data in a MySQL database For user authentication several methods are available and discussed in this document most common are servers that implement LDAP e g OpenLDAP or Microsoft Active Directory The next section briefly describes each of ZCP s components Chapter 1 Introduction ZCP Architecture Diagram o n v 5 6 Legend E bi x v 3 a n o a o amp es GS o lt oo ag cw a e se MAPI in SOAP connectivity E 2 as ov a 3 vt Sg 9 2 2 o v m LDAP connectivity co Os ce ae 9 mo Z 2 lg g Other connectivity P z ao 3 g 8 2 5 o 6 6 o9 U s amp E os zz lt E e Open Source Open Source Zarafa 3rd Party im Component Component Propietary Zarafa Component Propietary 3rd Party Component The Internet B 2 5 Service Server or Zarafa Exchange Redirector Zarafa WebAccess Zarafa Caldav Zarafa Gateway pop3 imap Zarafa Spooler Zarafa Delivery Agent LDAP Service d Zarafa 2000 and later Zarafa Windows T E 5 9 Ea gi f g B v H Zarafa S o g Zarafa ADS a CHEETA Quota H Plugin amp x EH H a o S a Zarafa
42. zarafa indexer cfg can be used index_block_users All user names which should not be indexed should be added to this configuration option Each name must be separated with a single SPACE character Similarly all users from specific companies can be excluded from indexing index_block_companies Again all companies which should be excluded must be separated with a single SPACE character For multiserver installations the filter works reversed Each server which must be indexed must be configured using the option index_allow_servers If this option is empty all servers within the environment will be included by the indexing service All server names must be separated by a single SPACE character Note Normally only a single zarafa indexer instance is needed for a multiserver environment For performance it is possible to run multiple instances on multiple servers By using using index allow servers correctly it is possible to divide the tasks over the different zarafa indexer instances 4 8 3 Indexer configuration During indexing the index file for each store is stored on the harddisk The location of these files can be configured in etc zarafa indexer cfg index path var lib zarafa index 34 CLucene configuration Beneath this folder a subfolder will be created for each Zarafa server within the environment Beneath these folders each store will receive its own folder containing the index files Importa
43. 0 or higher the database first needs to be upgraded with the scripts described above to the 5 0 format Then the 5 10 server can be started which will finalize the upgrade from 5 0 to 5 10 itself Later versions of Zarafa can always upgrade from a 5 0 database format or newer 11 3 Important changes since 4 x and 5 x A configuration option in the server cfg has been changed since 4 20 The option server name has been renamed to server bind A configuration file with typing errors in the option names or non existing options will render a service inoperable and it will not start All the errors found in the configuration file will be printed For the 5 0 version some unused options have been removed from the server configuration SQLite support was removed so the option internal path was also removed If this option is in the server cfg file please remove this line before starting the zarafa server process Options not set in a configuration file will keep their default value Default values can be found in the example configuration file found in usr share doc zarafa example conf ig Alternatively the specific manual page for the service can be read man zarafa lt service gt cfg The Zarafa services did not daemonise in versions before 5 0 However versions 5 0 and newer do daemonise and run in the background To revert this behavior use the F switch of a service to keep it running in the foreground Other configuration changes
44. 2 113 Chapter 12 Appendix B LDAP attribute description Syntax DirectoryString Multi or Single Valued Single Valued zarafaResourceCapacity This attribute will number of rooms or equipment available 1 3 6 1 4 1 26278 1 1 2 10 Integer Multi or Single Valued Single Valued zarafaHidden This attribute will hide the object in the Global Address Book Keep in mind that objects are never hidden for administrator users Syntax Integer Multi or Single Valued Single Valued zarafaAliases This attribute will contain all other email addresses for this user OID 1 3 6 1 4 1 26278 1 1 3 1 Syntax Multi or Single Valued DirectoryString Multi Valued zarafaUserServer This attribute will the homeserver of a user when running in multi server mode OID 1 3 6 1 4 1 26278 1 1 4 Syntax DirectoryString Multi or Single Valued zarafaSecurityGroup Single Valued This attribute will specify whether a group has security possibilities OID Syntax Multi or Single Valued 1 3 6 1 4 1 26278 1 2 2 1 Integer Single Valued zarafaViewPrivilege This attribute will contain companies with view privileges over the selected company OID 1 3 6 1 4 1 26278 1 3 2 114 Syntax DirectoryString Multi or Single Valued Multi Valued zarafaAdminPrivilege This
45. 6 3 3 Configuring the servers arsina aia a a aa aea alaaa da Daa 68 6 3 4 Creating SSL certificates pesia inrer ei o aoi a Nai a aa aa Eaa 68 6 4 Zarafa Windows Client Updater ccceceeeee cece cence scenes tantr eee meme ener renes 71 6 4 1 Server side configuration cece cece ee ee ee ee cece cece cece ee ee ee santas emen rennen 72 6 4 2 Client Side configuration cece ee cee ee cece eect ee ertt ertt nate eee emm nemen nnne 73 6 5 Running ZCP Services with regular user privileges ssse em 75 6 6 Single Instance Attachment Storage sssssssssssssee eene meer 75 6 6 1 Single Instance Attachment Storage and LMTP sssssseseeem 75 6 7 Single Sign On with ZCP ect e es ERR RR REGERE EX RE a Saa ATE 76 0 7 1 NTLM SSO With ADS irre dud eee Perte edet eol ect 76 0 7 2 NTEM SSO with Samba tci cot eret EE EHE REIR ER Le ERE EE E ac be REN o ad 78 6 73 SSO with Kerberos codec ener ve knee eH de eee Ape red vero eee 79 6 7 4 Up and r nning aude ete ero ede tut o euo eR ERREUR Rabe a Satis iniaa 82 7 Managing ZCP Services 83 Az Starting the ServiCes eo eee erue eeu ee eur de Re Pope cer e eee Pod eue e eaae e Edge om eva rave Ha 83 14 Stopping the ServiCeS i nece oe t t a M e edu E o dd e gend 83 7 1 2 Reloading service configuration sssssssssseem ene 84 4 2 Cogon Options voc eee ore ple t Hr ted etae Un edente
46. AP directory that has the user type attribute as mentioned in the previous section An additional search filter can be specified to limit store creation to a subset of the objects that have the user type attribute For example ldap user search filter zarafaAccount 1 All user related fields can be mapped by the following options ldap user unique attribute uidNumber ldap user unique attribute type text ldap fullname attribute cn ldap loginname attribute uid ldap emailaddress attribute mail ldap emailaliases attribute zarafaAliases ldap password attribute userPassword ldap isadmin attribute zarafaAdmin ldap nonactive attribute zarafaSharedStoreOnly The unique user attribute is the mapping between a mailbox in the database and the actual user in LDAP Make sure this field is never be changed as the Zarafa Server will perceive that as a user being deleted and created and will therefore orphan the user s store The email aliases are shown in the Global Address Book details and can be used for resolving email aliases in Postfix However it is not possible to deliver email to email aliases Extra user information like addresses phone numbers and company information can be mapped by an extra configuration file propmap etc zarafa ldap propmap cfg 42 Group configuration The specified attributes for users will also be used for contacts 5 2 4 Group configuration The groups can be filtered by an e
47. DB will result in a huge speed increase Also the InnoDB format is less error prone and has less overall table locking It is highly recommended to convert the database to InnoDB On the MySQL prompt import the script mysql gt source usr share doc zarafa db convert 4 20 to innodb sql Depending on the size of the database and the speed of the system this script will take a long to very long time Reserve up to 8 hours of time for this conversion to complete for a database with several gigabytes of data If the MySQL memory settings are optimized before this script is started it will run much faster db convert 4 2x to 5 00 109 Chapter 11 Appendix A Pre 5 2x upgrade strategies This perl script upgrades the database from 4 2x to the 5 0 format This script calculates and adds a store column to the properties table This makes the table sorted on the disk increasing data throughput Execute this script as described for the db convert 4 1 to 4 2 script Depending on the size of the database and the speed of the system this script might take a while but it will probably complete within 10 to 30 minutes on a fast machine Note It advisable to start this script with screen so this script can continue in the background 11 2 Upgrades from 5 0 to 5 1x and up The Zarafa 5 10 server can upgrade the database itself It can do this from the database version which is needed in 5 0 When upgrading from 4 x installations to 5 1
48. ERSCRIPT LOCALE to the correct language for example nl NL or fr FR On Ubuntu based systems it s required to use the utf 8 language pack In order to use this language setting make sure the language packs are installed Redhat and SUSE based systems contain all language packs by default but Debian and Ubuntu based systems do not contain these packages To install a language pack on Debian and Ubuntu based systems use the following command apt get install language pack nl The option ZARAFA LOCALE in the etc sysconfig zarafa or etc default zarafa file can be used to start the Zarafa Server component in the correct language This language setting is used to set the default options like the Public Folder name to the correct language The WebAccess GUI language can be set at the login screen This can be configured per user login For non English WebAccess languages the appropriate language packs need to be installed as well 4 2 1 User Authentication Another important configuration option for the Zarafa Server is the user plugin This setting determines which back end is used for managing users and groups There are four options namely db unix and ldap and 1dapms By default the db plugin is used as it does not require any further configuration The 1dap plugin is used most in larger setups as it proves to be most flexible and integrates nicely with an organization s the existing infrastructure The 1dapms plugin is required when confi
49. Qexample de is used for the addresslist German and mail example n1 for the addresslist Dutch Any combination with LDAP attributes are applicable This following example selects everyone that is a Zarafa administrator and has the character p in the cn value amp cn p zarafaAdmin 1 This example selects all users with mailaddress piet example com or klaas example com mail piet example com mail klaas example com 97 98 Chapter 9 Performance Tuning When installing a Linux server with Zarafa it is imperative that MYSQL is correctly configured to achieve maximum performance on the server almost all performance bottlenecks are within the database access itself so getting the SQL queries to run as quickly as possible is very important For large installations it is also a good idea to tune Zarafa s cache parameters as well These are normally set quite low to make sure that Zarafa can run on relatively low end servers but in anything but the smallest installations these defaults needs to be upped Any installation with 50 or more users should definitely tune the cache parameters for maximum performance This document assumes the primary role of the server is to run Zarafa Always make sure that other factors are taken into account for example an anti spam system or a webserver running a site other than the Zarafa WebAccess More information about performance tuning can also be found on htto
50. SI or SAS disks regularly have high rotation speeds of 10K or even 15K RPMs The rotation speed of the disks affects seek times on the disk Although the Zarafa database format is optimized to have data available on the disk in a serial fashion and most reads are done fairly localized on the disk seek time is still a large speed factor for I O The higher the rotation speed the lower the seek time 9 1 6 Hardware RAID Hardware RAID controllers often have large amounts of cache RAM This can also increase performance and data throughput of the I O subsystem If a hardware RAID controller is used however always make sure that either write back cache is not used or a functioning UPS and shutdown process for the server are available as write cached data will be lost when the power fails This is not only harmfull for the data that was written at that moment the write could actually corrupt the on disk innodb data 9 2 Memory Usage setup There are basically 4 large parts of the server setup that use server memory Zarafa s cell cache caches individual cell data within a table view e MySQL s buffer size caches reads and writes from the ibdata file e MySQL s query cache caches exactly repeated SQL queries In a server purely running Zarafa make sure these caches are setup to use around 80 of the RAM in the server The other 20 should be free for system processes other processes like MTA and the webserver For a general rul
51. VISIONING parameter should be enabled in the configuration If the messages continues the ActiveSync profile should be reconfigured on the device If this does not help the PROVISIONING could be disabled completely in the config file applies to all devices More information can be found at hitp www zarafa com wiki index php Z Push Provisioning Exceptions for Meeting requests cause duplicates if accepted on the mobile Please update to Z Push 1 4 or later In order to fix existing duplicates the ActiveSync profile on the mobile has to be recreated or at least the calendar has to be resynchronized completely disabling calendarsync and enabling it afterwards 58 Chapter 6 Advanced Configurations This chapter describes how to configure special setups that go beyond most common installations of ZCP 6 1 Running ZCP components beyond localhost When using the SSL connection with certificates it will not only be possible to encrypt the connection but Linux services will also be able to login using a client SSL certificate Repeat the certificate creation script to create certificates for client programs like the zarafa spooler zarafa monitor zarafa gateway and zarafa dagent It s possible to create one certificate for all these programs or a certificate can be created for each program separetely These clients can then login on the SSL connections with their certificate as authentication sh usr share doc zarafa
52. ZCP 6 40 build 24340 Zarafa Collaboration Platform The Administrator Manual Zarafa Zarafa Collaboration Platform ZCP 6 40 build 24340 Zarafa Collaboration Platform The Administrator Manual Edition 2 0 Copyright 2010 Zarafa BV The text of and illustrations in this document are licensed by Zarafa BV under a Creative Commons Attribution Share Alike 3 0 Unported license CC BY SA An explanation of CC BY SA is available at the creativecommons org website In accordance with CC BY SA if you distribute this document or an adaptation of it you must provide the URL for the original version All trademarks are the property of their respective owners The Zarafa Collaboration Platform ZCP combines the usability of Outlook with the stability and flexibility of a Linux server It features a rich web interface the Zarafa WebAccess and provides brilliant integration options with all sorts of clients including all most popular mobile platforms Most components of ZCP are open source licensed under the AGPLv3 can therefore be downloaded freely as ZCP s Community Edition Several closed source components exist most notably the Zarafa Windows Client providing Outlook integration the Zarafa BES Integration providing Blackberry Enterprise Server connectivity the Zarafa ADS Plugin providing Active Directory integration and the Zarafa Backup Tools These components together with several advance
53. Zarafa change the following configuration options in server cfg user plugin ldapms enable distributed zarafa yes server name lt servername gt server ssl enabled yes Note An upgrade from single server to multi server support is not a simple task Please check with the Zarafa Support if migration is possible for the setup used 6 3 4 Creating SSL certificates In a multi server setup it s required to configure SSL support because clients like the zarafa dagent zarafa admin zarafa monitor need a SSL certifcate to login to the different multi server nodes 68 Creating SSL certificates It s required to first create server side certificates so the Zarafa Server is able to accept SSL connections For the SSL authentication of the Linux clients like the zarafa dagent a private and public key need to be created Follow the steps below to create both the server and client certificates 1 First create the directory which will contain the certificates mkdir etc zarafa ssl chmod 700 etc zarafa ssl Create the server certificate by using the ss1 certificates sh script in the usr share doc zarafa directory which uses the openssl command and the CA p1 script Before a server certificate can be created a root CA is required If no root CA is found the script will first create an own CA cd etc zarafa ssl sh usr share doc zarafa ssl certificates sh server Enter a password passphrase if you
54. a in ZCP version 6 40 and later In earlier version the user must deleted and re created as a different type In LDAP setups the non active flag of users can be controlled through the ldap nonactive attribute configuration directive When using the DB back end it s possible to specify the non active flag with the n option when using zarafa admin to create users The Unix user plugin uses the unix shell of the user as specified in etc passwd to determine if the store should be a non active store Chapter 2 Installing 2 1 System Requirements 2 1 1 Hardware Recommendations To give an estimate on the resource use of ZCP we have created the table below These are merely guidelines giving a rough estimation on what hardware is required In this table we assume the CPU is under low load from other applications CPU Memory Harddisk Raid level Dual Core 1 Gb SATA SAS RAID1 Quad Xeon 2 5Ghz 4 Gb SAS RAID1 gt 250 Gb 2 x Quad Xeon 3Ghz 16 Gb SAS RAID10 Table 2 1 Hardware Recommendations Size of all mailboxes lt 5 Gb gt 5 lt 10Gb gt 10 lt 20Gb gt 20 lt 50 Gb gt 50 Gb lt 100Gb 2 1 2 Supported Platforms ZCP consists of a large variety of components some back end components that are run on Linux platforms and components that can be installed on the computers of end users In this section we list the different platforms that we support At the s
55. a spooler zarafa backup zarafa restore zarafa admin For advanced multi server environments and the best Zarafa configuration for a specific setup the Zarafa Professional Services are open for advise and support 6 4 Zarafa Windows Client Updater ZCP contains a mechanism that allows Zarafa Windows Clients to update themselves to the latest version Note The Zarafa Windows Client Updater is only available to those running the ZCP Professional or Enterprise edition 71 Chapter 6 Advanced Configurations Zarafa server Containing the latest Client updates Client PC With auto update Zarafa client HTTPS ClientPC Client PC Clients auto update themselves using the HTTPS protocol Figure 6 7 Auto update structure Restrictions The auto update mechanism does not support the ability to downgrade the client to a certain version it will always update the Zarafa Windows Client to the highest version available The Zarafa Windows Client Updater is not available for Windows 2000 or earlier releases 6 4 1 Server side configuration The Zarafa Windows Client Updater can be enabled by setting the following setting to yes in the server cfg of the zarafa server client_update_enabled yes When a zarafa server is upgraded it will copy the latest updated client installer to the path which is specified in the server configuration file server cfg As shown below client_update_path var lib zarafa c
56. an be executed For more information take a look at http support microsoft com kb 285172 Note Don t forget to switch the registry key back after the installation 5 3 1 2 Windows 2003 2008 Server For Windows 2003 and 2008 Server it s possible to step through the setup by clicking the next button If the Zarafa ADS Plugin is installed it is possible to edit the Zarafa specific attributes For editing a user go to users and computers select a user and get the properties The Zarafa tab should be available if the installation is successfully completed 45 Chapter 5 Configure 3rd Party Components benjamin test Properties v E Benjamin unit5 ztest nl default Modify Figure 5 2 Zarafa user tab 46 Configuring ZCP for ADS zarafa com Properties 2 xi General Managed By COM Zarafa company Zarafa company quota Group Policy General Zarafa Company Sysadmin EN s dministrator CN U sers D C homeworld DC local f r Remote view Remote administrators Add Delete Add Delete OK Cancel Apply Figure 5 3 Zarafa group tab 5 3 2 Configuring ZCP for ADS To integrate ZCP with an Active Directory server change the following option in the 1dap cfg configuration file Specify in the Idap host option the ip address or server name of the Active Directory server ldap host 192 168 0 1 At the moment ZCP does not support
57. arafa monitor start or zarafa monitor c etc zarafa monitor cfg 32 Quota warning templates The zarafa monitor will daemonise so the prompt will almost immediately return Use F to start it in the foreground More information about the configuration options can be found in the manual page man zarafa monitor cfg 4 7 4 Quota warning templates When working with the zarafa monitor it is possible to modify the contents of the email which will be sent out when a user or company exceeds its quota For each quota level a separate quota template can be specified these can be configured with the following options userquota_warning_template userquota soft template userquota hard template companyquota warning template By default the templates are stored in etc zarafa quotamail in each of these templates certain variables are provided which will be substituted for the real value before the email is sent ZARAFA QUOTA NAME The name of the user or company who exceeded his quota ZARAFA QUOTA COMPANY The name of the company to which the user belongs ZARAFA QUOTA STORE SIZE When a user exceeds his quota this variable contains the total size of the user s store When a company exceeds its quota this variable contains the total size of all stores including the public store within the company space ZARAFA QUOTA WARN SIZE The quota warning limit for the user or company ZARAFA QUOTA SOFT SIZE The quota
58. as parameters to the zarafa restore tool If the restore key of a container is entered the complete container with all its items will be restored on one level If the subcontainers of the selected container need to be restored add the r parameter to the command The following example restores the inbox with subcontainers from userA The restore key AF000000 is found in the userA index zbk file and needs to be defined at the end of the command zarafa restore u userA r c userA index zbk AF000000 106 Restore process The c parameter as a reference for the index file is not necessary when using an index file from the same user For example if using zarafa restore u userA the zarafa restore tool will automatically use the userA index zbk file when index zbk is in the same directory as where the command is executed In the next example a file keys txt containing multiple restore keys from multiple items and folders from user userA is used Every restore key in the file needs to be separated with a new line zarafa restore u userA r i keys txt For more options of the zarafa restore tool please check the man page man zarafa restore 107 108 Chapter 11 Appendix A Pre 5 2x upgrade strategies 11 1 Database upgrades from 4 1 or 4 2 Before Zarafa can be started again the database must be updated There are several scripts required depending on which version is upgraded from Upgrade scr
59. aving native SSL connections to the server has an interesting advantage Zarafa components running beyond localhost can login using their SSL certificate This section will describe how to setup certificates to add native SSL connections to Zarafa First we will create the directory to contain the certificate and setup the permissions since it contains our private key mkdir etc zarafa ssl chmod 700 etc zarafa ssl If Zarafa is run as another user as described in the Running as non root user section do not forget to chown the directory as well Now we are ready to create a Certificate Authority CA This CA will be used to create the server certificate and sign it We provide a ssl certificates sh script in the usr share doc zarafa directory which uses the openssl command and the CA p1 script from OpenSSL Depending on the distribution used this script can be installed in different directories The script will try to find it on its own If it is not found either OpenSSL is not installed or the script is in an unknown location and location of the script has to be provided manually Normally the ss1 certificates sh script can be run without problems cd etc zarafa ssl sh usr share doc zarafa ssl certificates sh server The parameter server is added so the name of the new certificate will be called server pem When the CA is not found in the default demoCA directory it needs to be created By pressing enter the creation
60. ay provides POP3 and IMAP access e zarafa ical provides iCal and CALDAV access for clients that use this type of calendar zarafa licensed needed when using any closed source zarafa module with zarafa server zarafa indexer provides a full text indexing service for quick searching through email and attachments zarafa dagent runs as a service when using local mail transfer protocol LMTP see Section 5 4 ZCP Postfix integration The zarafa server and zarafa spooler processes are mandatory to run Zarafa The zarafa monitor zarafa gateway and zarafa ical services are optional To start a service type etc init d zarafa servicename start Replace servicename with the service that needs to start To start the zarafa server type etc init d zarafa server start This script will start the server The init d scripts can start stop and restart the services If the init d script cannot be used the server needs to be started manually It is possible to explicitly tell the zarafa server where the configuration file is using the c switch usr bin zarafa server c etc zarafa server cfg The zarafa server will daemonise so prompt will almost immediately return Use F to start it in the foreground The F switch can also be used for programs like daemontools that monitor services 7 1 1 Stopping the services To stop a service type etc init d zarafa servicename stop Most services will stop almost immediatel
61. be purged from the database 30 days after they were deleted When this option is set to 0 zero the items will never be removed from the database Purges can also be triggered with the following command zarafa admin purge softdelete days days denotes the number of days that recently removed items are kept When 0 zero all removed items are purged For performance reasons a manual purge of the softdelete system is advisable for larger ZCP environments This can be simply configured by a cron job 85 86 Chapter 8 User Management 8 1 Public store Once the server has been correctly started stores can be created There are two type of stores Private and public stores There can only be one public store It can be created with the following command usr bin zarafa admin s The public store is the folder every user can always open After installation and configuration of the server a public store needs to be created first before private stores can be made If Zarafa is configured for multi tenancy a public store will be automatically created per company When using multi server support the Public store can only be created on the multi server node which has the ZarafaContainsPublic attribute enabled Currently the Public Store can be created on only one server See Section 6 3 2 Prepare setup the LDAP server for multi server setup for more information 8 2 Users By default the DB plugin wi
62. ces from the ZCP Webaccess without interaction of the system administrator The Mobile Device Management MDM plugin can be downloaded at http www zarafa com integrations mobile device management plugin 56 Upgrade The system administrator can remote wipe devices from the command line using the z push admin tool 5 5 5 Upgrade Upgrading to a newer Z Push version follows the same path as the initial installation When upgrading to a new minor version e g from Z Push 1 4 to Z Push 1 4 1 the existing Z Push directory can be overwritten when extracting the archive When installing a new major version it is recommended to extract the tarball to another directory and to copy the state from the existing installation A Important It is crucial to always keep the data of the state directory in order to ensure data consistency on already synchronized mobiles Without the state information mobile devices which already have an ActiveSync profile will receive duplicate items or the synchronization will break completely Please also observe the published release notes of the new Z Push version For some releases it is necessary to e g resynchronize the mobile 5 5 6 Troubleshooting General configuration Most of the difficulties are caused by incorrect Apache settings The Apache setup can be tested using a webbrowser like Firefox pointing it to http lt server gt Microsoft Server ActiveSync If correctly confi
63. ch was introduced in Zarafa 6 10 The feature is available in all editions but only officially supported in the Professional and Enterprise editions 59 Chapter 6 Advanced Configurations 6 2 1 Support user plugins Multi tenancy support can only be enabled when using the DB or LDAP plugin Currently it s not possible to use the Unix plugin When using the DB plugin the zarafa admin tool can be used to manage tenants companies while with the LDAP plugin all information will come directly from LDAP or Active Directory The preferred user plugin for multi tenancy setups is the LDAP plugin 6 2 2 Configuring the server The following configuration options in server cfg will be used when enabling the multi tenancy support enable_hosted_zarafa When set to true it s possible to create tenants within the Zarafa instance and assign all users and groups to particular tenants When set to false the normal single tenancy environment is created createcompany_script Location of the createcompany script which will be executed when a new tenant has been created deletecompany_script Location of the deletecompany script which will be executed when a tenant has been deleted loginname_format See Section 6 2 2 2 Configuring login name for more details about this configuration option storename_format See Section 6 2 2 3 Configuring store name for more details about this configuration option 6 2 2 1 Enabling M
64. ckup amp Restore Currently Zarafa provides three ways of restoring items Through the softdelete cache Using the brick level backup system Via a full database dump 10 1 Softdelete cache The softdelete cache can be used by users from Outlook with the Restore deleted items dialog from the Tools menu to restore deleted items This will cover most accidental deletions Items that are deleted by the user by emptying the deleted items folder or with a hard delete like shift delete in Outlook are simply placed in the deleted items cache This means that the item will not actually be removed from the database until the retention time of the item has expired This expiration time in can be specified in the server cfg configuration time and it set to 30 days by default Note that the restore deleted items dialog works on the currently selected folder In the following overview which possibilities can be performed by whom and when it s most likely used can be seen Restore request 96 of time spent Backup solution Performer Items lt 30 days old 80 Softdelete system User and Administrator Items gt 30 days old 10 96 Bricklevel Administrator Items from a specific 5 96 Bricklevel Administrator sender Items over a specific 3 Bricklevel Administrator time period Disaster recovery 2 MySQL Dump Administrator Table 10 1 Recovery options As can be seen the most common restore request
65. cryption and the certificate for authentication file can be set in the configuration file with ss1 private key fileand ssl certificate file The Zarafa Caldav component can also authenticate the calendar clients that try to connect to it verifying the client certificates using one or more verification files This can be set with ssl verify client ssl verify fileandssl verify path Certificates can be self signed or signed by a trusted certificate authority The following command generates an RSA key of 2048 bytes openssl genrsa out etc zarafa privkey pem 2048 This command creates a self signed test certificate valid for 3 years openssl req new x509 key etc zarafa privkey pem out etc zarafa cert pem days 1095 If a cer file and a key file are already present you can create a pem file from these using the following command cat my server key my server combined pem cat my server cer my server combined pem And then use the my server combined pem file for ss1 private key file or ssl certificate file Please make shure first the key file is processed and then the cer file 28 Calendar access 4 5 2 Calendar access Calendar folders served by the Zarafa Caldav component as accessed by URLs URL Calendar http server 8080 ical user s own default calendar via ical not recommended http server 8080 caldav user s own default calendar http server 8080 caldav lt other Other
66. cult to give a fixed value for what the optimal memory usage distribution is for a given server as data access patterns vary wildly from server to server We will describe some rule of thumb parameters here and make the RAM usage patterns as clear as possible here 9 1 2 Hardware considerations In servers running Zarafa the main performance bottleneck will be the route between the data on the hard disk and the time it takes to get to the client This means that generally I O performance is more important than CPU performance Using this as a basis the following pointers may help in selecting the correct hardware for the system 99 Chapter 9 Performance Tuning 9 1 3 More Memory is More Speed More RAM means better caching and therefore better speed Zarafa is specifically designed to make use of the large amounts of RAM that is available in modern servers On the other hand please remember that in normal Linux server the maximum amount of usable RAM in a 32 bit server is 3Gb unless PAE physical address extension is supported in the kernel CPU and mainboard If more than 3Gb is needed without some sort of limitation use a 64 bit system a 64 bit Linux OS and a 64 bit Zarafa package 9 1 4 RAID 1 10 is faster than RAID 5 In general a RAID1 or RAID10 array is faster at database accesses than RAIDS If it s an option always go for RAID10 9 1 5 High rotation speed RPMs for better database performance High end SC
67. d 4 4 Configure the Zarafa Spooler The Zarafa spooler sends email from the global outgoing queue to a SMTP server which sends the email to the correct address When an email message is sent from Outlook or WebAccess the message is placed in the Outbox folder and a submit message is sent to the Zarafa server The server notifies the Zarafa spooler to send the email to the SMTP server The spooler will now start to convert the message to a normal email message When the conversion is complete a connection to the supplied SMTP server is created and the email is sent to the SMTP server The spooler will send the email and after the mail is sent will move the mail automatically to the user s Sent Items folder If at any time an error was found the user will be notified with an Undeliverable message The message will contain an error description on which error was found Often the user can retry to send the message Note Both external and internal emails will be send via the MTA 4 4 1 Configuration The Spooler is configured the same as the server Options in the spooler configuration file are the name or ip address of the SMTP server where to find the Zarafa server and logging options smtp server The name or IP address of the SMTP server which will send the email to the destination This server may also be given as an argument when starting the spooler server socket The UNIX socket of the Zarafa server The spool
68. d by the user since the last backup the item will have a new last modification date and will be backed up again in it s totality since the backup would become unbearably slow if it would need to check all the properties of a message to see which property changed and which not Overwriting the old message is also problematic because the new message may be bigger than the old and it will not fit on the old space of the message Then when the actual backup process starts it will first remove the old index The index file will then be rebuild while the backup processes each message found in the list The data file will be appended with the new data keeping the old information which was still available and did not need to be stored again For more options of the zarafa backup tool use man zarafa backup 10 3 3 Restore process In order to restore items from the zarafa backup tool use the zarafa restore tool To restore items or complete folders find the corresponding restore key in the user index zbk file This index file isn t humanly readable with a text editor Instead use the readable index p1l perl script which can be found in usr share zarafa zarafa backup helpers To identify items use the container name field or the subject to find the items needed to be restored usr share zarafa zarafa backup helpers readable index pl username index zbk When the items are found place the restore keys in a separated file or give them
69. d features for large setups and hosters are only available in combination with a support contract as part of ZCP s Commercial Editions Alternatively there is a wide selection of hosted ZCP offerings available This document the Administrator Manual describes how to install upgrade configure and maintain ZCP on your Linux server In addition various advanced configurations and integration options are discussed t http creativecommons org licenses by sa 3 0 http www gnu org licenses agpl 3 0 html http www zarafa com content community i http www zarafa com content editions 1 Introduction Ti Intended Audience eos rre en day a a aa Ta ia ear exa an Ee tease Tx A AERE Sa T2 Architecture 53 etd et ect re beta eet oet eta ree dla a a vea dea etd be Eo ol 1 3 Components vitesse el eti dei oe Petre M Pede tout 1 4 Protocols and Connections ispisiri iadro eene enne mense nine nnne senes LAN SOAP T 1 4 2 Secure HTTP HTTPS iios ie e RR EGER ATED EDE 1 5 ZCP Editions and Licensing ineei ee aa iaa te ered 1 5 1 The Trial ICerse 5 ect a Ev ee e FREE ot ea AEE ECC YER 1 5 2 The ZCP Community Edition sssssssssssseeem meme emere 1 5 3 Commercial Editions of ZOP ssssssssssseeeeneee eene ee eene nennen ne 1 5 4 Active and non active Users sssssssssssesen ee eene nennen senses 2 Installing 2 1 System Requirements 22 rete tr dre tee tabe dy PaL eret e rbd ve teo p
70. d updates successfully if the default Outlook profile is configured to work with a Zarafa Server and if updates are available at that server Even with the setting to prompt for the profile to be used the Zarafa Windows Client Updater will succeed provided the greyed out drop down menu specifies the profile configured for Zarafa Please refer to the User manual on how to configure Outlook profiles 74 Running ZCP Services with regular user privileges 6 5 Running ZCP Services with regular user privileges Normally the Zarafa services are run as root Since version 5 0 there is the option to change the user the service runs as and still start the services as root However there are several things to do before the services can correctly run as a non root user If the log_method is set to file make sure this directory and file is writable by the user or group the service will be running as When a logrotate happens by sending the service the HUP signal a new file is created which will be owned by the user the service is running under The service should still be started as root since it will create a pid file under the system location var run and will open the network sockets which most likely have a number under 1024 which may only be opened as root The following example shows how to configure the zarafa server to run as user zarafa and group zarafa addgroup system zarafa adduser system home dev null
71. de a changed the php mapi extension the webserver has to be restarted as well etc init d apache2 restart or etc init d httpd restart 18 Chapter 4 Configure ZCP Components Most ZCP and 3rd party components are configured by a configuration file This section explain the most common options that are set to get these component up and running It is important to note that components usually have to be restarted to make use of updated configuration files read more about this in the Chapter 7 Managing ZCP Services In short after modifications have been made to a component s configuration file that component has to be restarted with etc init d zarafa component name restart 4 1 Configure the Zarafa Server The Zarafa Server component is configured by a system wide configuration file usually located here etc zarafa example cfg When installing ZCP an example of this file is put here usr share doc zarafa example config server cfg The options and their default values are explained both by the in line comments of the example file and in the following manual page man zarafa server cfg If a line is not present the default setting will be assumed For most basic setups the defaults of the example file will work fine In this chapter we only explain the basic configuration option of Zarafa Server The Zarafa Server needs a MySQL database to function and therefor needs to know how to connect to the MySQL ser
72. de information from Global Address Book sssssee eH 94 8 8 Address lists Dy Condition irr eere eese ep Pe RR aaa ANa 95 8 8 1 Setup addresslists in OPENLDAP sssssssssee memes 96 8 8 2 Setup addresslists in Active Directory ssssss em 96 8 8 3 Condition examples iie e eter en eei ret ade re Deva Fe a ERE RE NY 97 9 Performance Tuning 99 9 1 Hardware Considerations eseis eoan AE e SrO EANA EENAA EEN nnne nennen nnn enne nennen 99 9 1 1 Memory usage cce texte ee eT entere a Pu e REPE Rue DUE 99 9 1 2 Hardware considerations 20 2 eect eee erent rete emere 99 9 1 3 More Memory is More Speed sssssssssssee emen hee nens 100 9 1 4 RAID 1 10 is faster than RAID 5 siitoin eenei Hen 100 9 1 5 High rotation speed RPMs for better database performance 100 9 1 6 Hardware RAID 3 dn nte en d deo b eese ren Loi uem eae edes 100 9 2 Memory Usage Setup oii Pee eere eO Ed De eR EN E EAE eee 100 9 2 1 Zarafa s Cell Cache cache cell size 101 Zarafa Collaboration Platform 9 2 2 Zarafa s object cache cache object size 101 9 2 3 Zarafa s indexedobject cache cache indexedobject size 101 9 2 4 MySQL innodb buffer pool size 101 9 2 5 MySQL innodb log file size 101 9 2 6 MySQL innodb log buffer size 102 9 2 7 MySQL query cache size eieaa a niaaa aa 102 9 2 8 Setup of modules on different
73. dicator of how many items there are in the folder a last modification unix timestamp and a type of the folder eg IPF Note for a mail folder IPF Appointment fora calender The last part of a C entry is the name of the folder which may contain a colon itself so therefore it is the last part in the entry A detailed list of the fields for a Container can be found in the appendix The Min the index stands for Message which can be any type of message or item It has a parent key which matches a folder key Then it has a restore key which can be used to restore this specific message A unix timestamp follows which is the last modification time of the message If a user changed the message this timestamp will be updated The index entry continues with the type of message mail calendar meeting request etc The entry contains an offset where the item starts in the data file and lastly contains the subject of the item Since this subject may contain colons it is at the end of the entry A detailed list of the fields for a Message can be found in the appendix The data file is a binary dump of all the message properties recipients and attachments Folders are only set in the index file thus only the name is backed up since that is enough to recreate the folder 10 3 2 Backup process When a first backup of a store is created the backup tool will perform the following actions Create a list of all the folders and their contents of the st
74. dresslist 3 Setthe cn attribute to the unique name of the addresslist 4 Create a condition query in the zarafaFilter attribute see Section 8 8 3 Condition examples for example condition queries a ou Addresslists Name Value Type cn Sales E objectClass posixGroup Attribute CJ cn Administration objectClass zarafa addresslist Attribute zarafaFilter mail zarafa nl Attribute cn German E gidNumber 10003 Attribute E cn Dutch Attribute Figure 8 3 Addresslists in LDAP After restarting the zarafa server the addresslists should be visible in the global addressbook 8 8 2 Setup addresslists in Active Directory To setup an addresslist in Active Directory it s required to have the Zarafa ADS plugin installed 1 Select a folder in the Active Directory tree from the Users and Group console 2 Create the new addresslist by Action gt New gt Zarafa Addresslist 3 Insert the name of the addresslist 4 Open the properties of the new created addresslist 5 Adda search filter for the address see Section 8 8 3 Condition examples for example condition queries 96 Condition examples 8 8 3 Condition examples For example the Global Address Book contains Dutch and German users It is possible to view these users per country by creating two addresslists in the LDAP tree All German users have the domain example de in the mail address and all the Dutch have example nl In this situation the condition mail
75. e config directory Based on these examples the etc zarafa 1dap cfg file should be adjusted to configure the LDAP authentication plugin More information of the configuration options for this plugin can be found with man zarafa ldap cfg 21 Chapter 4 Configure ZCP Components More details about configuring the LDAP plugin with OpenLDAP see Section 5 2 Configure ZCP OpenLDAP integration or Section 5 3 Configure ZCP Active Directory integration for Active Directory 4 2 2 Autoresponder ZCP contains an autoresponder that can be used when a user is out of the office to reply automatically to all incoming e mails The autoresponder will automatically be spawned whenever an e mail is delivered by zarafa dagent to a store that has the Out of Office option turned ON Users can manage the autoresponder of their own store as well as of stores to which one has at least secretary rights Note that this includes public folders Please refer to the User manual on how to manage these settings To prevent autoresponder loops e g when sending automated responses to an automated response which in turn sends an automated response etc the autoresponder will only send one autoresponse message per day for any unique sender e mail address The autoresponder will also not respond in any of the following cases Sending an out of office message to yourself Original message was to mailer daemon postmaster or root Or
76. e PHP is configured with register globals off If a distribution in combination with SELinux is used an error message while logging in may appear when using the WebAccess The default message suggests that the entered password is wrong or the Zarafa server is not running When SELinux is enabled it is blocking the connection from the webserver to the Zarafa server This can be solved by allowing Apache to make network connections setsebool httpd can network connect 1 or by disabling SELinux altogether setenforce permissive When it is chosen to disable SELinux etc sysconfig selinux also has to be edited to disable it for after reboots too SELinux information can be found here hitp fedora redhat com docs selinux faq 13 14 Chapter 3 Upgrading 3 1 Preparing Before upgrading to a new version of ZCP it is recommended to make a backup of the database and the configuration files First stop the running services so database is not in use anymore etc init d zarafa spooler stop etc init d zarafa server stop etc init d zarafa licensed stop And the optional services too if they were started etc init d zarafa dagent stop etc init d zarafa gateway stop etc init d zarafa ical stop etc init d zarafa indexer stop etc init d zarafa monitor stop N Important When the attachments are kept in the database an upgrade to 6 30 x or later will grow database storage file by the combined size of all a
77. e nd 2 1 1 Hardware Recommendations sssssse emen 2 12 Supported Platforms 2 edet ote DER Hetero Le e c oa 21 3 Dependencies ziegi ipina HERR ERI i LER E FERAE EEAR SOR sede gaan ER SRI gee sada cdas pinia 2 2 Installation eene 2 2 1 Installing ZCP with a Package Manager sssssssneem eem 2 2 2 Installing with the Install Script 2 2 3 Manually Installing Packages 2 3 Troubleshooting Installation Issues 2 3 1 Server processes 2 3 2 WebAccess nccc 3 Upgrading 3 1 Preparing uoto etg ets 3 2 Creating backups ssussse 3 3 Performing the Upgrade 3 3 1 From 6 30 to 6 40 3 4 Finalizing the upgrade 4 Configure ZCP Components 4 1 Configure the Zarafa Server 4 2 Configure language 4 2 1 User Authentication 4 2 2 Autoresponder 4 2 3 Storing attachments outside the database ssssssseseeem 4 2 4 SSL connections and certificates ssssssssssse emm 4 3 Configure the License Manager 4 4 Configure the Zarafa Spooler 4 4 1 Configuration 4 5 Configure Zarafa Caldav 4 5 1 SSL TES serere 4 5 2 Calendar access 4 6 Configure
78. e of thumb the following RAM distribution should be used Zarafa caches cache cell size around 25 of total RAM size cache object size about 100kb per user cache indexedobject size about 512kb per user 100 Zarafa s Cell Cache cache cell size MySQL caches e innodb buffer pool size around 25 of total RAM size mysql query cache 32Mb e innodb log file size 25 ofthe innodb buffer pool size e innodb log buffer size 32M This will cause around 5096 609 of the RAM to be tied up in caches for MySQL and Zarafa The actual memory usage of the MySQL and Zarafa will then be slightly more than this giving a total of around 8096 of RAM size Please refer to the MySQL documentation for the setting of the innodb log file size and related settings as these should also be somewhat higher than the defaults to increase write performance They don t affect read performance The 4 settings will now shortly be discussed to illustrate the need of each of these cache settings 9 2 1 Zarafa s Cell Cache cache cell size Data that is actually shown to the user in table views passes through the cell cache This means that any view of a table in Outlook will only retrieve the information from the database of the cells that are not already in the cache The cache lifetime is as long as the entire server lifetime so opening an inbox twice in succession should result in disk accesses for the second access It is a good idea to
79. e server also accepts HTTPS connections the proxyed connections can also be encrypted The proxy and proxy html modules of Apache need to be loaded IfModule mod proxy c ProxyPass zarafa http 127 0 0 1 236 ProxyPassReverse zarafa http 127 0 0 1 236 lt IfModule gt This means that URLs that begin with zarafa will be forwarded to localhost on port 236 where the Zarafa Server listens for incoming connections These lines can be placed globally or within a VirtualHost declaration Keep in mind that using the HTTP proxy has some performance overhead so for larger setups it s not recommended to use this 5 2 Configure ZCP OpenLDAP integration In several network infrastructures OpenLDAP is used as the directory server keeping track of various bit of information most notably users and their permissions ZCP integrates with LDAP servers and supports OpenLDAP in particular 40 Configuring OpenLDAP to use Zarafa schemas Zarafa doesn t include a LDAP server in the product so if there is not yet a LDAP server available in the environment one has to be setup or the non LDAP user plugin has to be used Please read the documentation of the used Linux distribution on how to setup an OpenLDAP server Connections to OpenLDAP servers run over port 389 or 636 SSL For best speed and reliability it is always best to install an OpenLDAP server on the same physical host as the Zarafa Server that replicates with the main LDAP
80. e the specific multi server configuration files The following LDAP configuration entries need to be configured for a multi server setup ldap server type attribute value zarafa server ldap user server attribute zarafaUserServer ldap server address attribute ipHostNumber ldap server http port attribute zarafaHttpPort ldap server ssl port attribute zarafaSslPort ldap server file path attribute zarafaFilePath ldap server search filter ldap server unique attribute cn 7 Every created Zarafa user in the LDAP server needs to be assigned to a Zarafa server node This can be set by using the ZarafaUserServer attribute The attribute should contain the unique server name In a multi tenancy situation all created tenants companies in LDAP needs to be updated with the zarafaCompanyServer attribute Use the server name as well for this 6 3 3 Configuring the servers The following configuration options in server cfg are provided for Multi server support enable distributed zarafa Enable multi server environment When set to true it is possible to spread users and companies over multiple servers When set to false the single server environment is created server name The unique server name used to identify each node in the setup This server name should be correctly configured in the DNS This server name should be the same as the value of the zarafaUserServer attribute To enable multi server support in
81. ecting through ssl the dagent will verify the private against the root CA On RedHat based systems where the root CA is placed in a different path the root CA needs to be added to the CA bundle e g cat etc CA cacert pem gt gt etc pki tls certs ca bundle crt This way the dagent is able to verify the private key against the CA bundle On Ubuntu systems this step can be ignored If the test case is successful it is possible to change the following value in the dagent cfg back to server_socket file var run zarafa Deploy all certificates to the different multi server nodes scp r etc zarafa ssl etc zarafa sslkeys root node2 etc zarafa Remember to copy the root CA to the different nodes if this file is placed outside the directories that have just been copied 70 Zarafa Windows Client Updater 15 Repeat the above steps to configure the server cfg and dagent cfg on all the different nodes On RedHat based nodes also add the root CA to the CA bundle When done test remote delivery width zarafa dagent v c etc zarafa dagent cfg username on other node Subject test email Test ctrl d This delivery should not result in any delivery errors otherwise please check created certificates It s now possible to deliver email from a central MTA to the different multiserver nodes The client SSL certificates can be used for the following tools to connect to a remote Zarafa server zarafa dagent zaraf
82. ed Only when Outlook integration is used the zarafa licensed daemon is required After the new packages are installed the example configuration files found in the usr share doc zarafa example config directory can be checked for new configureation options The new features are discussed in Section 11 3 Important changes since 4 x and 5 x There are also Perl and sql scripts which upgrade the database format for the new version Some scripts have to be run for the new version of ZCP to start while other scripts are recommended for speed increases 3 3 1 From 6 30 to 6 40 There are some configuration changes in version 6 40 to support new features in the Global Address Book like contacts dynamic groups and security groups Especially when using the LDAP user plugin the server will not start correctly without any changes to the LDAP configuration file being made If the DB or Unix plugin is in use no changes are required to the configuration files However it may be helpful to view them to configure new options Please check the upgrade page on http wiki zarafa com for up to date upgrade details To correctly support contacts from Microsoft Active Directory the 1dap user unique attribute config field must be changed from objectSid to objectGuid Since this is the unique identifier for users changing this without updating the database will make the Zarafa server delete all users and recreate the new detected users This is not wa
83. ent configurations are possible most of which are beyond the scope of this document Note Configuring antispam and antivirus scanning is beyond the scope for this manual On the internet many example configurations are available for the most common MTAs and scanners 5 4 1 Configure ZCP Postfix integration with OpenLDAP The Postfix MTA can connect to an OpenLDAP server to resolve primary mail addresses and aliases of users and groups The Postfix package in most Linux distributions has LDAP support enabled by default To read more about Postfix LDAP support see the LDAP README on the Postfix website All Postfix configuration files can be found in etc postfix directory The main configuration file is logically called main cf By default Postfix will only accept incoming emails from localhost To accept emails from the complete network configure the following option inet interfaces all 2 http Awww postfix org LDAP_README html 50 Configure ZCP Postfix integration with Active Directory In order to make Postfix aware of the local emaildomains add the following line to the main cf virtual_mailbox_domains example com example org example net Postfix will now see the configured domains as it s local email domains however to accept incoming emails Postfix will do a recipient check Add the following lines to the main cf to have Postfix use LDAP for looking up valid recipients virtual mailbox maps ldap
84. ent that the dump started When using mysqldump it is very important not to do any table locking This means that the opt option and lock tables should never be used while dumping a Zarafa database The reason is that these options will lock the tables while they are being dumped to disk causing any accesses to the database to freeze while the backup runs This is firstly unnecessary and secondly may cause emails that are arriving during backup to bounce depending on the MTA settings A simple mysqldump single transaction p lt database gt gt lt dumpfile gt will start a good dump of the database 10 2 2 Binary data dump via LVM Snapshotting This technique uses the LVM Snapshot feature to effectively freeze a binary view of the database file while the database keeps running This frozen view is then simply binary copied to a remote server This works because innodb makes sure that a single snapshot of a database will always be coherent ie It will be able to recover the database when mysql is started up on this dataset As setting up LVM and configuring LVM for snapshots is a complex process we refer the user to the LVM documentation and tools on how to set up an LVM volume for the MySQL data and how to create and delete snapshot partitions 10 2 3 Attachments backup When using the attachments storage outside the database make sure that these attachments are also backupped Some bac
85. er ldap group unique attribute objectSid ldap group unique attribute type binary For the membership relationships between groups and users each group object has a group member attribute This can be configured by ldap groupmembers attribute member ldap groupmembers attribute type dn By the security group attribute group can be specified as security groups in Active Directory Security groups will only displayed when settings permissions and are not default available in the Global Address Book ldap group security attribute groupType ldap group security attribute type ads 5 3 5 Addresslist configuration Addresslists are groups of users that match a custom condition These addresslists are showed as subfolders of the Global Address Book Address Book Type Name Show names from the d Global Address Book iv Global ddress Book Administration B File as e Display Name German Sales Aaltje Aaltje Test Contacts Marisa Test Abel Abel Test Abel rotterdam uni 4 Abigail Abigail Test Abiaail rotterdam Figure 5 4 Addresslists in Global Adress Book Change or add in ldap cfg the following configuration settings for the addresslist objects ldap addresslist search filter ldap addresslist unique attribute cn ldap addresslist unique attribute type text ldap addresslist filter attribute zarafaFilter ldap addresslist name attribute cn See Secti
86. er will use this socket to create a connection to the server This value should be the same as set in the server configuration file The default value is var run zarafa 1ogging The spooler has the same configuration options as the server to configure logging options For an overview of all the configuration options of the zarafa spooler use 26 Configure Zarafa Caldav man zarafa spooler cfg 4 5 Configure Zarafa Caldav Zarafa Caldav is a component that enables users to view their calendar data by clients that support the Caldav standard like Sunbird or Evolution This component connects with the Zarafa Server using MAPI over HTTP Caldav and iCal push and retrieve complete calendars Sunbird and other clients support both retrieving and pushing while Evolution does only support retrieving of calendars The Zarafa Caldav component can be configured using a configuration file in the same fashion as the Zarafa Server It supports both plain and SSL TLS secured connections To increase security it is recommended to enable secure Caldav connectivity exclusively The configuration options are server bind IP address to bind to 0 0 0 0 for any address Default value 0 0 0 0 ical enable Enable plain service with value yes Default value yes ical port The plain service will listen on this port for incoming connections Default Value 8080 icals enable Enable secure service with value yes Default value no icals
87. erride the system wide quota settings for all users within the company OID 1 3 6 1 4 1 26278 1 1 1 Syntax Integer Multi or Single Valued Single Valued 111 Chapter 12 Appendix B LDAP attribute description zarafaUserDefaultQuotaWarn This attribute contains the warning quota level in Mb for all users with the company OID Syntax Multi or Single Valued 1 3 6 1 4 1 26278 1 1 1 6 Integer Single Valued zarafaUserDefaultQuotaSoft This attribute contains the soft quota level in Mb for all users with the company OID 1 3 6 1 4 1 26278 1 1 1 Syntax Multi or Single Valued Integer Single Valued zarafaUserDefaultQuotaHard This attribute contains the hard quota level in Mb for all users with the company 1 3 6 1 4 1 26278 1 1 1 8 Integer Multi or Single Valued Single Valued zarafaAdmin This attribute will make a user Zarafa administrator OID 1 3 6 1 4 1 26278 1 1 2 Syntax Integer Multi or Single Valued zarafaSharedStoreOnly This attribute will configure a mailbox as a shared store On shared stores you will not be able to login Single Valued OID 1 3 6 1 4 1 26278 1 1 2 2 Syntax Integer Multi or Single Valued Single Valued zarafaAccount This attribute can be used in the LDAP search filters to filter users and groups OID Syntax Multi or Single Valued 1 3
88. ers user information and groups Zarafa Gateway zarafa gateway Optional service to provide POP3 and IMAP access to Zarafa users Zarafa Monitor zarafa monitor Service which monitors user stores for quota exceeds Zarafa Caldav zarafa caldav Optional service that provides iCal and CalDAV support CalDAV is recommended due to speed and less data transfer Zarafa Backup Tools zarafa backup zarafa restore A brick level backup tools to create simple backups of stores and to restore part of those backups on a later point in time This part is only available in Zarafa commercial editions Zarafa Indexer Optional service to provide full text indexing This offers fast searching through email and attachments Apache Serves web pages of the WebAccess to the users browser PHP The WebAccess is written in this programming language PHP MAPI extension Module for PHP to enable use of the MAPI layer Through this module MAPI functions are made accessible for PHP developers This effectively means that MAPI web clients can be written The WebAccess is such a client For connectivity with mobile devices we recommend using Z Push see Section 5 5 Configure Z Push Remote ActiveSync for Mobile Devices an open source implementation of the ActiveSync protocol For older mobile devices and mobile devices that do not support the ActiveSync protocol we ship the Zarafa WebAccess Mobile zarafa webaccess mobile
89. etailed information about the devices and their compatibily status please consult the Mobile Compatibility List at httip Zz push sourceforge net compatibility 5 5 2 Security To encrypt data between the mobile devices and the server it s required to enable SSL support in the web server Configuring Apache with SSL certificates is beyond the scope of this document though many howtos can be found online Keep in mind that some mobile devices require an official SSL certificate and don t work with self signed certificates 5 5 3 Installation Download the latest Z Push software from http z push sourceforge net download To Install Z Push simply untar the Z Push tar to the webroot with tar zxvf z push lt version gt tar gz C var www html The C option is the destination where the files need to be installed In the following table the default webroot directories of where some distributions lets the Apache webserver search for files Distribution Default webroot Red Hat Enterprise Linux var www html SUSE srv wwwilhtdocs 55 Chapter 5 Configure 3rd Party Components Distribution Default webroot Debian and Ubuntu IvarAwww Table 5 1 Webroot directories Make sure that the state directory is writeable for the webserver process so either change the owner of the state directory to the UID of the apache process or make it world writeable chmod 755 var www z push state chown apache apache var
90. etc postfix ldap users cf virtual alias maps ldap etc postfix ldap aliases cf virtual transport lmtp localhost 2003 All incoming emails are delivered to the LMTP service of the zarafa dagent The delivery needs to be done on the primary mail address of a user For resolving the primary mail address of the user create the file etc postfix ldap users cf and add the following lines localhost ou Users dc example dc com server_host search_base version 3 scope sub query_filter mail s result_attribute mail For lookups of mail aliases create the file etc postfix ldap aliases cf and add the following lines localhost ou Users dc example dc com server_host search_base version 3 scope sub query filter zarafaAliases s result_attribute mail The search base of users and aliases need to match the search base of the LDAP server After the configuration files have been changed Postfix need to be restarted etc init d postfix restart Make sure the zarafa dagent is run as a daemon and started at boot time chkconfig zarafa dagent on etc init d zarafa dagent start 5 4 2 Configure ZCP Postfix integration with Active Directory The Postfix can resolve primary mail addresses and aliases of users and groups from the Active Directory server The Postfix package in most Linux distributions has LDAP support enabled by default To read more about Postfix LDAP support see the LDAP README on the Postfix website
91. etting up delegation via zarafa admin is only applicable with the DB or UNIX plugin For setting up LDAP or Active Directory see Section 8 5 User Management with LDAP or Active Directory mailto info example 89 Chapter 8 User Management Add a user to the list of the delegate being updated as a send as user The delegate can now send mails as the updated users name unless the updated user set the delegate as a user based delegate This option is only valid with the u update action zarafa admin u lt delegate gt add sendas lt user gt Remove a user from the list of the delegate being updated as a send as user This option is only valid with the u update action zarafa admin u lt delegate gt del sendas lt user gt List all users who are in the list of the delegate zarafa admin list sendas lt delegate gt Note All previous settings concerning delegation have to be reconfigured when upgrading to 6 2x or later Unfortunately a reset of these settings is needed in order to have this additional functionality available 8 3 Groups The server supports groups Users can belong to any number of groups Every user always belongs to the special group Everyone Defining security settings on folders and items are the same for both users and groups For example the group Everyone has read access to the Inbox of Peter At this point every user may read the email in Peter s Inbox because all
92. f SUSE but only for SLES Besides these packages that are build and shipped by us there are several platforms supported by community build packages For example Fedora Mandriva Gentoo Arch Linux and OpenBSD We also have packages in the Canonical Partner Repository Please have a look at our wiki page on this topic for more information MS Windows Release Supported CPU Architectures 32bit 64bit 32bit 64bit 32bit 64bit Windows Server 2003 Windows Server 2008 Windows XP Windows Vista 32bit 64bit Windows 7 32bit 64bit Table 2 3 Supported platforms for ZCP s Windows Client Migration Tool and ADS Plugin These are the supported Microsoft Windows platforms the components that require a Windows platform namely the Windows Client the Migration Tool and the ADS Plugin Note The Migration Tool is currently not available for 64bit platforms Supported browsers by ZCP s WebAccess Officially we support Mozilla Firefox 3 0 up to the latest version and Internet Explorer version 6 to 8 We recommend Firefox as it is more secure and performs better z https fedoraproject org wiki Zarafa 3 http en gentoo wiki com wiki Zarafa http aur archlinux org packages php ID 31174 http openports se mail zarafa zarafa 5 http www zarafa com wiki index php Install Zarafa from Ubuntu Repository Dependencies Although not officially supported most modern
93. f d auth kerb conf Add the following lines at the end of this file Alias webaccess usr share zarafa webaccess lt Directory usr share zarafa webaccess gt AuthType Kerberos AuthName Kerberos Login KrbMethodNegotiate On KrbMethodK5Passwd Off KrbServiceName HTTP KrbAuthRealms ADSDOMAIN LOCAL Krb5KeyTab etc httpd conf keytab apache require valid user Directory Set the filesystem permissions of the keytab file to 400 and change the owner to the Apache user chmod 400 etc httpd conf keytab apache chown apache apache etc httpd conf keytab apache Restart Apache to activate all changes e g for Redhat service httpd restart 6 7 3 6 WebAccess configuration To setup a Single Sign On environment for Zarafa Collaboration Platform its necessary to make a trust between the Apache webserver and the Zarafa Storage Server The trust is necessary to handle the Webaccess authentication by the Apache webserver not by the Zarafa Storage Server anymore To create this trust add the running Apache user to the following line in the etc zarafa server cfg local admin users root apache 81 Chapter 6 Advanced Configurations To configure the Zarafa WebAccess for Single Sign On change the following option in the config php file define LOGINNAME STRIP DOMAIN true Note In this configuration we assume the Zarafa WebAccess is installed on the same server as the Zarafa Storage Server Restart the Zarafa se
94. f data in this example and all the 30 users can access the attachment through a reference pointer 6 6 1 Single Instance Attachment Storage and LMTP To use the Single Instance Storage it s required to use the LMTP delivery method executed from the virtual transport in Postfix 75 Chapter 6 Advanced Configurations With the aforementioned setup externally received email with an attachment sent to multiple internal users will be processed efficiently by saving the attachment only once The usage of virtual transport in Postfix will deliver only one email with a list of the internal users to the dagent instead of one email per internal user Without virtual transport option Single Instance can not know that the attachment is similar in the email item s Note Single instance attachments are accessible between tenants companies as well even when the tenants cannot view each other the handling of single storage will be transparent Thus considering the example above if user A sends the message to 30 users of tenant1 and 50 users of tenant2 provided that the tenants reside on the same server only one copy of the attachments is saved Note Single instanced attachments will be handled per server when sending an email with attachment to multiple Zarafa users spread over multiple servers each server will get its own Single instance attachment 6 7 Single Sign On with ZCP This chapter will describe how to set up a Si
95. ganization unit for each Zarafa Server node in the multi server setup 3 Y de zarafal 192 168 0 23 3 ou Zarafa MS Example 3 cn groups B cneservers cn zarafal ih cnezarafa2 E cn users uid cody uid imar uid vin Figure 6 5 Setup directory with all the multi server nodes Add all the multi server nodes to this directory or organization unit In Active Directory the Computer template can be used for this When using OpenLDAP a custom LDAP object can be created with the device and ipHost objectClass Every multi server node should have a common name FQDN or ip address and the Zarafa server details Make sure the FQDN can always be resolved by the clients Figure 6 6 LDAP server attributes Name Value cn ZdsMaster E objectClass device E objectClass ipHost objectClass zarafa server E objectClass top zarafaContainsPublic 1 zarafaFilePath var run zarafa E zarafaHttpPort 236 zarafaSslPort 237 E ipHostNumber 192 168 0 63 The ZarafaContainsPublic attribute can only be set for one multi server node At the moment there is not support for multiple Public Folders on different nodes The Zarafa LDAP configuration needs to be extended with some extra multi server configuration options An example configuration file for the multi server setup can be found in the usr 67 Chapter 6 Advanced Configurations share doc zarafa example config directory The files ldapms cfg ar
96. gured a window requesting username password should be displayed Authenticating using valid credentials should display Z Push information page containing the following message A Z Push information page should be displayed containing the message GET not supported This is the z push location and can only be accessed by Microsoft ActiveSync capable devices Verify the PHP and or Apache configuration if an error is displayed Synchronization problems If synchronization problems are encountered a debug txt file has to be created in the root directory of Z Push This file should be writeable by the Apache server process touch var www Zz push debug txt chmod 777 var www z push debug txt The debug txt file will collect debug information about the synchronisation To obtain a complete synchronization log the file woxm1 php has to be edited and the parameter WBXML DEBUG set to true 57 Chapter 5 Configure 3rd Party Components define WBXML DEBUG true TA Important The debug txt logfile contains sensible data and should be protected so it can not be downloaded from the internet To protect the debug txt logfile a htaccess has to be created in the z push root directory containing lt Files debug txt gt Deny from All lt Files gt Log messages Repeatedly Command denied Retry after sending a PROVISIONING command Most probably the mobile device does not support provisioning The LOOSE_PRO
97. guring a multi server Zarafa environment Multi server support is only available in the Enterprise edition More information on managing users can be found in Chapter 8 User Management 4 2 1 1 The DB Authentication Plugin This plugin uses the Zarafa MySQL database to store user and group information The zarafa admin tool can be used to manage users The DB plugin supports only basic user and group information For more advanced configurations we advise to use the LDAP plugin 20 User Authentication For more information about user management with the zarafa admin tool see Chapter 8 User Management 4 2 1 2 The Unix Authentication Plugin The Unix plugin is used on a server which has all its user information setup in the etc passwd file Group information will be read from etc group Passwords are checked against etc shadow so the zarafa server process must have read access to this file this process is normally run as root so usually that is not a problem Since the unix files do not contain enough information for Zarafa there are some properties of a user that will be stored in the database These properties are the email address overriding quota settings and administrator settings The zarafa admin tool has to be used to update these user properties All other user properties are done using the normal unix tools A configuration file etc zarafa unix cfg exists for this plugin The default set by this file a
98. iginal message was from mailer daemon postmaster or root Furthermore the autoresponder is configured by default to respond only to e mails in which the user was explicitly mentioned in the To header This means that e mails that were received because the user was in the Cc header or because the user was in a distribution group are not responded to Most behaviour can be configured by editing the file etc zarafa autorespond This file contains the following settings which will be used for all autorespond messages server wide AUTORESPOND CC 0 Set this value to 1 to allow autoresponding to messages in which the recipient was only stated in the Cc header AUTORESPOND NORECIP O Set this value to 1 to autorespond to all messages even if the recipient is not stated in any header for example when the email was directed at a mailing list or group TIMELIMIT 24 60 60 Sets the minimum number of seconds between autoresponses to the same e mail address The following settings normally do not need to be modified SENDDB TMP tmp zarafa vacation USER db file which stores the last date of sending per email address SENDDBTMP TMP tmp zarafa vacation USER tmp 22 Storing attachments outside the database temporary file used during update of the database SENDMAILCMD usr sbin sendmail command used to send actual vacation message SENDMAILPARAMS t f parameters used to send actual vacation
99. ill contain the port for the https connections when running in multi server mode OID 1 3 6 1 4 1 26278 1 4 4 Syntax Integer Multi or Single Valued zarafaFilePath This attribute will contain the unix socket or the named pipe of the server when running in multi server mode Single Valued DirectoryString Syntax Multi or Single Valued zarafaContainsPublic This attribute will enable the public store for a specific multi server node Make sure only one node has enabled this attribute Single Valued OID Syntax 1 3 6 1 4 1 26278 1 4 4 4 Integer Multi or Single Valued Single Valued zarafaFilter This attribute will contain the LDAP filter to apply for an addresslist or dynamic group OID 1 3 6 1 4 1 26278 1 5 5 1 Syntax Multi or Single Valued DirectoryString Single Valued zarafaBase This attribute will contain the LDAP search base to apply for an addresslist or dynamic group OID 1 3 6 1 4 1 26278 1 5 5 Syntax DirectoryString Multi or Single Valued Single Valued 116
100. index max buffered docs 10 Larger values will increase memory usage but makes the indexing process faster Larger values also mean that less index segments will be written to disk which controls how often the segments will be merged also depending on the index merge factor configuration option The minimum number of messages in a single store which are indexed in memory before the index writer flushed the index to disk as a new index file is controlled using the index min merge docs option index min merge docs 10 Creating new index file segments often increases IO access to disk but reduces the amount of memory required during the indexing process The maximum number of documents which can exist in a index file segment can be controlled by the index max merge docs option index max merge docs 2147483647 When a segment contains index max merge docs documents it will no longer be merged with other index segments This will limit the total size of an index file segment but will trigger more index file segments to be created For batch indexing when index interval is set to a high value the index max merge docs should be set to a high value as well 210000 For interactive indexing when index intervalis set to a low value set index max merge docs to a low value lt 10000 The fraction of terms in the dictionary which should be stored in memory is controlled by the index_term_interval configuration option index_ter
101. ion Administrator Properties Ed Fo Published Certificates Member Of Dakin Object Security Environment General Address Account rofle Telephones Organization Sessions Remote control Terminal Services Profle COM Zarafa Quota Other 7 Use user quota Zarata Account Wamingat fO Mb mA ei I Hide from addressbook Soft limit E 50 Mb Capacity o Hard limi 0 Mb Po Po Home i srt E mail addresses admin example com default Add Delete Delete M3dify Set as default Figure 8 1 Hide a user from the Global Address Book using Active Directory 8 8 Address lists by condition Addresslists are groups of users that agree with any custom condition so users do not need to be assigned to groups These groups are accessible for users in the global address book 95 Chapter 8 User Management Address Book Type Name Show names from the Global Address Book B File as Display Name Administration go Aafke Aafke Test 25 Aaliyah Aaliyah Te 2 Aaltje Aaltje Test Abel Abel Test Abel rotterdam unr Abiaail Abigail Test Abiaail rotterdam Figure 8 2 Addresslists in the Address book Contacts Marisa Test 8 8 1 Setup addresslists in OpenLDAP To setup an addresslist in OpenLDAP follow these steps 1 Create an Organisation Unit for all the addresslists in the LDAP tree 2 Create a new LDAP object and add the objectClass zarafa ad
102. ions By default this is disabled because it requires the creation of SSL certificates When the server certificate is created SSL connections can be directly accepted from a client As an extra option other Zarafa components like the Zarafa Delivery Agent and the Zarafa Spooler can also connect over HTTPS to the server and authenticate using the Zarafa Server s private key 1 5 ZCP Editions and Licensing 1 5 1 The Trial License When using a trial license a period of time is available to test ZCP with full functionality It is possible to continue using the current database when a valid commercial license is installed A trial license can be requested on http www zarafa com serial_request 1 5 2 The ZCP Community Edition The Zarafa Collaboration Platform community edition is licensed under the Affero GPLv3 This edition can be used with for up to three users with the proprietary Zarafa Windows Client for connecting with Microsoft Outlook The WebAccess IMAP gateway and mobile synchronisation can be used for unlimited users a http www zarafa com content affero gplv3 Commercial Editions of ZCP Note To have Outlook support in the community edition the proprietary License Manager component must be running A license is not needed though 1 5 3 Commercial Editions of ZCP Standard Professional and Enterprise editions require a commercial license It will be mentioned in this document whenever a feature or co
103. ipts are only needed when upgrading from a 5 0x version or older The scripts are as follows db convert 4 1 to 4 2 This perl script upgrades the database from 4 1 to the 4 20 format These are changes that regard how users are stored in the database This script is required and should be run as follows perl usr share doc zarafa db convert 4 1 to 4 2 lt dbuser gt lt dbpass gt lt dbname gt Replace lt dbuser gt with the username used to connect to the database Replace lt dbpass gt with the password of the database user If there is no password enter 2 single quotes here Replace lt dbname gt with the name of the Zarafa database This will result in something like perl usr share doc zarafa db convert 4 1 to 4 2 root zarafa db convert 4 20 to 4 21 This perl script upgrades the database from 4 20 to the 4 21 format It will replace an indexing key to improve database speed This script is highly recommended and should be run as explained for the db convert 4 1 to 4 2 script Depending on the size of the database and the speed of the system this script might take a while but it will probably complete within 10 to 30 minutes db convert 4 20 to innodb sql This SQL script converts the converted 4 20 database to InnoDB format Installations that started at version 4 0 created MyISAM tables However the current SQL database layout is optimized for the InnoDB format Therefore converting the MyISAM database to Inno
104. ist locally on the Zarafa server then the user is created on the fly before returning the information to the caller 91 Chapter 8 User Management This means that for users and administrators the synchronisation seems to be real time never will there be a delay between adding or removing users from the LDAP server and the users showing up in Zarafa Because all Zarafa components use the same MAPI interface to connect to the server backend a situation can t arise with any of the Zarafa tools where the user database is out of sync For example delivering an email to a user that was just created will never fail due to the user not existing in the Zarafa users table The drawback to this is that any user and any process can trigger the addition and deletion of users the timing of store creation and deletion is therefore not easy to predict However for the vast majority of installations this is not a problem 8 5 2 Add Remove events The mechanism above creates a situation in which there are six events that can be signaled User creation Group creation Company creation User deletion Group deletion Company deletion These six events can be coupled to a script which will be described later so that system administrators can perform specific actions on their servers with these events By default Zarafa will only perform the absolute necessary actions during these events ie store creation and removal Any o
105. kup methods thtat can be used to backup the attachments Rsync Copy all files to external backup server or external attached hard drive Use of a commercial backup agent for Linux like SEP Bacula Arkeia or others 10 3 Brick level backups The commercial editions of ZCP provide a brick level backup tool This tool will create a backup of the mailboxes to separate files The second time a backup is performed only the changed and new items are added to the backup 104 Backup format Please note that this kind of backup is not meant for disaster recovery Only items are written in the backup No information about the users or specific information the user create like rules are not backed up 10 3 1 Backup format The backup tool creates 2 files for each mail store a data file and an index file The index file contains information about folders the hierarchy and messages The fields are colon separated There are 3 types of entries in the index file which are R C and M The R stands for Root and is always the first and the only R entry in the index It contains a key which folders use as their parent key to denote that they are directly connected to the root container of the store The C stands for Container which can be any type of folder It has 2 keys one parent and one to identify the container itself It also has a unique restore key This key can be used to select the folder for the restore tool It has an in
106. lient 72 Client side configuration The updates at the client update folder follow a naming convention The Zarafa Server will work only with those updates that adhere to this convention zarafaclient lt major version gt lt minor version gt lt update number gt lt build number gt msi For example zarafaclient 6 40 0 19050 msi is a valid name of an update Based on this naming convention the Zarafa Windows Client Updater finds out if an update of the client is available If a suitable version is available for a client zarafa server will send the update to the client machine to update itself with the latest client version By default clients communicate with the server over HTTP on port 236 HTTPS on port 237 unless a non default port is specified in the server cfg Clients send a request to download a virtual file which provides the most current version of the client available on the server The client communicates with the server using an encrypted message format This prevents misuse of this mechanism for any malicious intent Note If the default profile is set to use encryption via port 237 the root CA certificate needs to be installed on the desktop used 6 4 2 Client side configuration The Zarafa Windows Client s auto update mechanism consists of an application to start the auto update process by the name of ZarafaLaunchUpdater exe and a windows service known as ZarafaUpdaterService exe Zarafa Upda
107. limit the user will not be able to sent email until the size of the store is reduced When the hard quota limit is reached email can also not be delivered to that user anymore 4 7 1 Setup server wide quota The server wide quota can be configured in the configuration file of the server quota_warn 100 quota_soft 150 quota_hard 200 The values are all in megabytes These values will be honored for all users present in the server When the values are set to 0 that particular quota level is disabled 4 7 2 Setup quota per user By using the zarafa admin tool the user quota can be set for a specific user Example Set the quota of the user John with the settings Warning level to 80 Mb soft level to 90 Mb and hard level to 100 Mb zarafa admin u john qd qw 80 qs 90 qh 100 Note Set user quota with zarafa admin does not work with LDAP With LDAP the properties are stored in the LDAP server per user See the t for more information 4 7 3 Monitoring for quota exceeding The zarafa monitor program checks every hour by default for users who have exceeded a quota level and sends emails to a user when the warning or soft quota limit is exceeded Global quota settings can be set in the server configuration User specific levels can be set via zarafa admin when using the db or unix plugin or by editing the LDAP values as described in the User Management section To start the zarafa monitor use etc init d z
108. ll be used as user management plugin Below will be described how to manage users with the zarafa admin command For user management with the LDAP user plugin please see Section 8 5 User Management with LDAP or Active Directory At the moment ZCP doesn t provide a graphical user management interface 8 2 1 Creating users To create a new user use the following command usr bin zarafa admin c user name gt p password e email f full name a administrator The fields between should be filled in as follows User name The name of the user With this name the user will log on to the store Password The password in plain text The password will be stored encrypted in the database e Email The email address of the user Often this is user name Q email domain Full name The full name of the user Because the full name will contain space characters and maybe other non alphanumeric characters the name should be entered with qoutes Administrator This value should be 0 or 1 When a user is administrator the user will be allowed to open all Zarafa stores of any user It is also possible to pass 2 as administrator level this will make the user a system administrator who can create modify delete companies All fields except the email address are case sensitive 87 Chapter 8 User Management The password can also be set using the P switch The password is then not given at the com
109. m_interval 128 Smaller values use more memory but make searching slightly faster while larger values use less memory and make searching slightly slower Searching is typically not dominated by dictionary lookup so tweaking this is rarely useful All CLucene writers and searchers are cached to optimize performance at the expense of memory The time in seconds the objects will be kept in cache is controlled by the index_cache_timeout option 36 Attachments index_cache_timeout 0 If set to caching will be disabled 4 8 5 Attachments Optionally the contents of attachments can be indexed as well When this is enabled when searching through the body of a message the contents will be searched through as well To enable indexing of attachments can be done in etc zarafa indexer cfg index attachments yes Indexing of attachments is done through parsing the attachments to plain text and indexing the text into the main index for the email The required time to parse and index a particular attachment depends on the actual size of the attachment To prevent large attachments adding latency to the total indexing time the configuration option index attachment max size can be used to prevent large attachments to be indexed The value provided to this configuration option must be set in kilobytes To parse the attachments to plain text a separate configuration script must be provided By default this script is installed to e
110. made quite easily simply by configuring the various parts of the system to communicate with another server For the MySQL server this only has to be accessed by the zarafa server process on Server2 This can very easily be done by setting the correct login and host configuration in Zarafa s server cfg The Zarafa Server will itself be contacted by Outlook Clients Server3 MTA and Server4 WebServer This can be done because the zarafa server process is listening on port 236 on Server2 and the other servers can connect with it Server3 will accept email on port 25 or fetch email via some email protocol like POP3 After passing the email through anti spam and anti virus the email will be passed to the zarafa dagent process The zarafa dagent process can be configured to connect with an SSL certificate with Server2 This SSL certificate is required because the zarafa dagent needs to be authenticated because it is connecting from a different server over port 236 When this is configured in both Server3 and Server2 the email can be delivered directly to Server2 by Server3 Server4 is the WebAccess server running Apache and accepting connections on port 80 or 443 for SSL The Zarafa WebAccess can be configured in config php to connect over port 236 or port 237 for SSL to Server2 for the actual data Once this has been configured this server is ready to serve users No additional configuration is required 102 Chapter 10 Ba
111. main This is no requirement but this makes the document a bit more clear on how to create the Kerberos principal 6 7 3 2 Active Directory configuration Create two Kerberos principals in Active Directory one for SSO with WebAccess and one for SSO with Outlook 1 Adda new user httpd linux to the Active Directory this user will be used to create the principal for SSO with WebAccess username may differ 79 Chapter 6 Advanced Configurations 2 Add anew user zarafa linux to the Active Directory this user will be used to create the principal for SSO with Outlook username may differ 3 Make sure that the option Password never expires is enabled 4 On the account properties for these users enable Use DES encryption types for this account 5 After setting this account property it is strongly advised to reset the password for these users On the Active Directory Server install the Windows Support tools which include the ktpass exe program The Support tools can be found on the Windows Server install cd or can be downloaded from the Microsoft website Execute the following command to create the keytab file for the Apache webserver ktpass exe princ HTTP zarafa 1linuxdomain local ADSDOMAIN LOCAL mapuser EXAMPLE httpd linux crypto DES CBC MD5 ptype KRB5_NT_PRINCIPAL mapop set desonly pass a out c keytab apache Execute the following command to create the keytab file for the Zarafa Server ktpass exe princ za
112. man page man zarafa ldap cfg 5 3 Configure ZCP Active Directory integration 5 3 1 Installing the Zarafa ADS Plugin and schema files ZCP provides an installer for extending the Active Directory schema and installing an Active Directory snap in for managing the Zarafa specific attributes The Zarafa ADS plugin is only available in the commercial editions of ZCP and can be downloaded on https portal zarafa com The Zarafa ADS Plugin should be installed on the Active Directory server which is the schema master as a local administrator user 5 3 1 1 Windows 2000 Server When the installation is run on a Windows 2000 Server the setup requires write access to update the Active Directory Schema To get the write access the registry key Schema Update Allowed must be enabled 44 Installing the Zarafa ADS Plugin and schema files To edit the registry key perform the follow steps 1 Click Start click Run and then in the Open box type regedit Then press ENTER 2 Locate and click the following registry key HKEY LOCAL MACHINENSYSTEMNCurrentControlSetNServicesNNTDSNParameters 3 On the Edit menu click New and then click DWORD Value 4 Enter the value data when the following registry value is displayed Value Name Schema Update Allowed Data Type REG DWORD Base Binary Value Data Type 1 to enable this feature or 0 zero to disable it 5 Quit Registry Editor Now the Zarafa Active Directory installer c
113. mand prompt but asked for by the zarafa admin tool The password is not echoed on the screen and needs to be typed twice for verification 8 2 2 Non active users A non active user cannot login to ZCP but email can be delivered to this user and the store can be opened by users with correct permissions Non active users can especially used for functional mailboxes resources and rooms To create a non active user use the following command zarafa admin c lt user name gt P e lt email gt f lt full name gt n 1 In the Unix Plugin users with a special shell default bin false are non active users Note In ZCP version 6 30 and earlier it s not possible to switch an active user to non active and vice versa Switching the non active value will trigger a mailbox deletion 8 2 3 Updating stores and user information The same zarafa admin tool can be used to update the stores and user information Use the following command to update usr bin zarafa admin u lt user name gt U lt new user name gt p lt new password gt e lt email gt f full name gt a lt 0 1 gt All the changes are optional For example only the password for an existing user may be updated leaving the other user information the same as it was 8 2 4 Deleting users To delete a user from the server use the following command usr bin zarafa admin d lt user name gt The user will be deleted from the database However the s
114. map 53 Chapter 5 Configure 3rd Party Components virtual_mailbox_maps hash etc postfix virtual virtual_alias_maps hash etc postfix virtual virtual transport lmtp localhost 2003 The file etc postfix virtual should contain all email addresses and aliases of a user in the following structure useri example com useri example com useri example net useri example com alias_useri example com useri example com info example com user2 example com useriQexample com The left column contains the email address or alias the right column contains the primary email addresses on which the message should be delivered After all users and aliases are added to this file a hash map needs to be created The following command will create the actual hash map etc post fix virtual db postmap etc postfix virtual All incoming emails are delivered to the zarafa dagent over LMTP using the primary mail address of as specified in the hash map After changing the configuration files restart Postfix by its init script etc init d postfix restart Make sure the zarafa dagent runs as daemon and is started at boot time chkconfig zarafa dagent on etc init d zarafa dagent start Note It s advised to enable logging of the zarafa dagent when running in LMTP mode for monitoring purposes To alter logging options for the zarafa dagent adjust the configuration file etc zarafa dagent cfg 5 5 Configure Z Push Remote ActiveSync fo
115. message If an alternate autoresponder is required please refer to the zarafa dagent manual page which describes how to use an alternate script using the a option 4 2 3 Storing attachments outside the database Since ZCP version 6 0 it is possible to save the attachments outside the database The default method is to save the attachments inside the database like older versions of ZCP For first time installations the attachment storage method should be selected before starting the server for the first time as it is not easy to switch the attachment storage method later on To change the attachment storage location edit the following option in the etc zarafa server cfg attachment storage files For upgrades a script exists that copies the attachments from the database to the file storage This script can be found in usr share doc zarafa and is named db convert attachments to files This script is run as follows db convert attachments to files mysqluser mysqlpass lt mysqldb gt destination path delete It is only possible to convert from database storage to file storage The delete switch is optional If this parameter is given the attachments are also removed from the database Keep in mind that during the conversion the storage of the attachments on the harddisk will double The amount of storage in MySQL used by ZCP can be looked up the with the following MySQL statements mysql use zarafa mysql
116. mon administrative tasks with ZCP Important Although we Zarafa try our best to keep the information in this manual as accurate as possible we withold the right to modify this information at any time without prior notice 1 1 Intended Audience This manual is intended for system administrators responsible for installing maintaining and supporting the ZCP deployment Readers of this manual will benefit from prior experience with Linux system administration Setting up MTA s we use Postfix in this manual LDAP servers like OpenLDAP or Microsoft Active Directory Managing a MySQL installation 1 2 Architecture In accord with the UNIX philosophy ZCP consists of components that each take care of a well defined task See Figure 1 1 Zarafa Collaboration Suite Architecture Diagram which describes the relationships between the components and the protocols used This diagram describes a simple setup as used by most of our customers Only the most commonly used components are shown in the diagram The top part of the diagram shows the clients software appliances by which users access their data Some of these appliances are desktop applications some are mobile applications In between The Internet and the Zarafa Server the infrastructure components of Zarafa blue and some common infrastructure components grey can be found These components are needed to facilitate communication between the Zarafa Server and
117. mponent only available is with a commercial edition 1 5 4 Active and non active users ZCP licenses are on a per named user basis A base license is a license for a fixed number of users which can be extended by adding extra Client Access Licenses i e having a base license for 10 users and a CAL for 10 users is functionally equivalent to having a 20 user base license Licenses are based on named users i e 10 named users can be added in a system with 10 licensed users However there are also users which do not add to this user count these are so called non active users they cannot login An example of a non active user is an info or helpdesk user This is a user in the respect that it can receive email and has all the standard folders but it is not allowed to login Other users will open the info store as a delegate store and retrieve email from there Each license automatically allows an extra amount of non active users The amount of non active users is 50 of the active user count allowed by license with a minimum of 20 Examples License 10 users Active users 10 Non Active users 20 License 400 users Active users 400 Non Active users 200 If not all active user accounts are used it s possible to use them as non active accounts instead Note Users are set active or non active at the time of creation It is only possible to convert active users to non active users or vice vers
118. n be used to create these folders If Microsoft Active Directory is run make sure that the real users are in a separate LDAP folder so that Zarafa doesn t need to import the standard users like Administrator and Guest into the database It is also possible to filter the users using an LDAP search query but these search queries can become unsatisfactorily large when using ADS As a general rule always use the LDAPS SSL protocol while contacting the LDAP server When SSL is not used information will be transmitted clear text over the wire This opens possibilities to sniffing user and administrator passwords from the network wire Zarafa supports connecting through LDAP via SSL and a certificate specified in etc 1dap ldap conf which is compatible with both Microsoft Active Directory as OpenLDAP servers Zarafa does not yet currently support STARTTLS type encryption 8 6 Send as Permissions option After inserting the zarafa schema s and setting up the user structure it is possible to use specific settings intended for Zarafa One important setting is the Send as Permissions This setting will be explained for LDAP though also applicable for ADS 93 Chapter 8 User Management To read more about Permissions please read the Zarafa server manual for the administrative side and the Zarafa client manual for the user side 1 Select the user that need to be used as the sendas user 2 Add the ObjectClass zarafa user
119. n file for more information about the loginname attribute Note When passing a username to the zarafa admin tool it should be formatted as configured For example if the Ioginname format configuration value includes company name variable c the company name should be passed to the zarafa admin tool everytime a username is needed 6 2 2 3 Configuring store name When relations between multiple tenants companies are allowed it is possible that users share their store with users from other tenants To easily differentiate stores from different tenants the store name can be formatted to contain the tenant s name companyname to which the user store belongs In server cfg the configuration option storename format is provided for exactly this purpose In the format different variables are provided which can be used to different kinds of information u The username f The fullname of the user 96c The companyname name of the tenant to which the user belongs Some examples for a user named John Doe who is member of the tenant Exampleorg e u gt john f gt John Doe f c gt John Doe Exampleorg 6 2 2 4 Configuring the LDAP plugin When using the DB plugin no additional configuration is required For the LDAP plugin there are several configuration options that might require changes 61 Chapter 6 Advanced Configurations For a multi tenancy LDAP setup it s necessary
120. ndexer uses the open source CLucene library for indexing and searching all messages in the stores CLucene can be configured through the following configuration parameters By changing the maximum field length the maximum number of words from a single message which will be indexed can be controlled All words above the maximum will be discarded index max field length 10000 This value is used to control the amount of required memory during the indexing process When index max field length value is increased the more memory will be required during indexing The merge factor indicates the number of index file segments per store before CLucene merges the segments into a single file 35 Chapter 4 Configure ZCP Components index_merge_factor 10 A low value will cause less memory to be used during indexing but the increased IO access to disk causes the indexing process to be slower while searching will be faster A high value will speed up the indexing process while searching will be slower For batch indexing the index_interval option is set to a high value In that case set index_merge_factor to a high value gt 10 as well For more interactive indexing where the index intervalis set to a low value the index merge factor should be set to a low value 10 The maximum buffered documents controls the maximum number of documents kept in memory before CLucene writes them into a new index file segment on the harddisk
121. ngle Sign On environment with ZCP so users can authenticate without entering their password ZCP supports both the NTLM and Kerberos authentication protocol The Kerberos support is available from ZCP 6 40 2 and higher Both methods will be described in the following sections 6 7 1 NTLM SSO with ADS 6 7 1 1 Installing Linux software The following software needs to be installed winbind kinit Depending on the linux distribution used this comes through various package names On Debian use apt get install krb5 user winbind krb5 user will also install the Kerberos library configuration files in etc The package winbind depends on samba common which will therefore be installed as well On Red Hat Enterprise Linux both the krb5 workstation and the samba common package are required for this To enable NTLM SSO with ZCP set the following option in etc zarafa server cfg enable sso ntlmauth yes 76 NTLM SSO with ADS 6 7 1 2 ADS Specific network setup The following prerequisites have to be met before proceeding Every server must have a DNS name so their IP addresses can be found by DNS The time of all servers must be in sync Time cannot lag for a few minutes This document has the following names as example FQDN of the Windows ADS server ADSSERVER ADSDOMAIN LOCAL Therefore the windows server is named ADSSERVER the realm is ADSDOMAIN LOCAL and the workgroup name is ADSDOMAIN Workstations can
122. ns And creating a new group for tenant exampleorg would be 63 Chapter 6 Advanced Configurations usr bin zarafa admin g group exampleorg other options 6 2 5 Quota levels When using a multi tenancy installation there are 2 types of quota namely the quota for the tenant company and the quota for the individual user The quota for the tenant is checked over the total store size of all users within that tenant plus the public store At this time only the warning quota can be configured for a tenant this means it is not possible to set the soft or hard quota to limit the tenant s email capabilities Just like the user quota there are multiple levels for tenant quota and there is even a new level for the user quota A summary of the possible quota levels which can be set in a multi tenancy environment 1 Tenant company quota a Global company quota Configured in etc zarafa server cfg and affects all tenants within the system b Specific company quota The quota level for a tenant configured through the plugin LDAP or zarafa admin tool 2 User quota a Global user quota This is configured in etc zarafa server cfg and affects all users from all tenants b Company user quota This is the default quota level for all users within a tenant and is configured through the plugin at tenant level c Specific user quota This is the quota level for a specific user and is configured through the use
123. nt Files and folders within this index path should not be touched while the indexer is running If a store must be re indexed the zarafa indexer must be halted first before deleting the folder for that particular store The zarafa indexer service can use streaming synchronization offered by the zarafa server for fast synchronization of messages at the expense of higher memory consumption To enable streaming ensure that the configuration option is enabled index_sync_stream yes If this option is enabled the enhanced ICS option in etc zarafa server cfg must be enabled as well enable_enhanced_ics yes These options are both enabled by default and normally there is no reason to disable them The indexing interval can be configured in etc zarafa indexer cfg index_interval 5 This interval should be provided in minutes When this value is increased the delay between receiving the mail and its visibility in search results will also be increased The indexing of stores can be divided over multiple threads when working on a multiserver environment The number of index threads can be configured by changing the configuration value index_threads ab Each thread will only index the stores from a single Zarafa server The number of threads will thus never exceed the number of servers within the multiserver environment For single server environments this value should be kept at 1 4 8 4 CLucene configuration The zarafa i
124. nted so it s required to use the db upgrade objectsid to objectguid p1l script found in usr share zarafa doc directory This script will detect the LDAP settings from the existing etc zarafa server cfg file and change the database to the new unique id After the script it s required to update the LDAP configuration file to use the new unique attribute Make sure the Zarafa server process is not running when using this script The send as options in LDAP are the opposite from 6 30 as of 6 40 This change is done to support groups for the sendas permissions If the send as options for users are used the 1dap switch 16 Finalizing the upgrade sendas p1 script must be run This script will update the LDAP or ADS server with the current send as information and switches it to the 6 40 format In 6 40 delegations are set on the user Example A non active user info company exists and some users need to send with that address in the from header The users are added on the info company object in the send as attribute list In the LDAP configuration the separate search base options for each object are combined in one search filter option named 1dap search base All other old search base options should be removed Also all scope options should be removed Next object types must be defined This normally goes through the objectClass attribute Every user object must be defined by it s objectClass Lastly the old per object search
125. nterprise license key is necessary and a running zarafa licensed is required 6 3 1 Introduction The ZCP multi server feature gives the possibility to distribute ZCP over multiple servers In this situation the Zarafa user stores are divided over several servers but still acting as one central system The users groups and tenants companies have to be managed in a LDAP or Active Directory server Location A user user2 user3 user4 Servers serverA serverB Central LDAP ADS server Ww Zarafa server A Zarafa server B Figure 6 2 Multiserver environment on one location The multi server support can also be used to support larger number of users or to spread mailboxes over different geographical locations see Figure 6 3 Multiserver environment on two locations 65 Chapter 6 Advanced Configurations Location A Location B LDAP M pe synchronisation Master LDAP ADS Replica LDAP ADS Server server Zarafa server A Zarafa server B Figure 6 3 Multiserver environment on two locations The mailbox of a user is always stored on only one server It s not possible to synchronize mailboxes over multiple servers When accessing mulitple mailboxes that are located on different servers the client will make a connection to the different multi server nodes See the flowchart Figure 6 4 Multiserver environment Zarafa LDAP Server Server Node 1
126. of the new CA is started Enter a password passphrase when asked for This is the password used later on to sign certificate requests Then certificate information should be entered Do not leave the Common Name field blank otherwise the creation will fail 24 Configure the License Manager Now that we have a CA we can create self signed certificates The ss1 certificates sh script will automatically continue with this step Enter a password for the request and enter the certificate details Some details need to be different from those typed when the CA was created At least the field Organizational Unit Name needs to be different The challenge password at the end may be left empty This step created a Certificate Request that needs to be signed by the CA that was created in the first step of the script Type the password of the CA again when asked for The details of the certificate will be shown and asked for acceptance Accept the certificate As the last step the public key of this certificate will be offered Since the server certificate just was created the public key of this certificate is not needed Now that the the CA certificate and the server certificate have been created SSL can be enabled in the server cfg file which is normally disabled The port 237 is set for SSL connections This port number can be changed if necessary server_ssl_enabled yes server_ssl_port 237 The CA certificate must be set in
127. og method is set to file this is the variable that defines the name of file The server needs write access to the directory and file log level Increase the level of messages that will be logged Level 6 is the highest level log timestamp 1 or 0 This will enable or disable a timestamp when using a file as the log method Logging of other services than zarafa server are configured in a same manner as the server 7 3 Soft Delete system If a user deletes emails calendar items or complete folders there are by default moved to the Deleted Items folder When the items are removed from the Deleted Items the items still will not be fully removed from the database Rather they are marked as deleted so the user does not see the items Even when a 84 Soft Delete system user deletes items with lt SHIFT gt lt delete gt they are not removed from the database but marked as deleted This makes restoring of items quick and easy from Outlook choose Extra from the menu bar in Outlook menu and click on Restore deleted items Items are grouped by the folder they were deleted from Most items will appear in the Deleted Items folder as they have been removed from that location Soft deletes always remain in the database until they are purged When an item will be purged is set by the softdelete lifetime configuration value The default value is 30 days In this example the value is set to 30 This means that deleted items will
128. oin Finish by typing the Administrator password If successful the prompt should give Joined domain lt DOMAIN gt The SSO configuration is now done To test if authentication actually worked try the following command ntlm_auth username john Where john is a valid Samba user The program will asks for a password After entering the password it should say NT_STATUS_OK Success 0x0 If this step does not work try restarting winbind check the DNS names check with strace what ntlm auth tries to do check with tcpdump if there is actual traffic on the network from nt1m auth to the domain server and other lowlevel debugging tools 6 7 3 SSO with Kerberos 6 7 3 1 Requirements and Conventions e The server that runs ZCP must have the MIT Kerberos software installed ZCP version 6 40 2 or higher needs to be installed for SSO with Outlook Every server must have a DNS name so their IP addresses can be found by DNS It is even better to make sure that all servers also have PTR records setup correctly The time of all servers must be in sync Time cannot lag for a few minutes This document has the following names as example FQDN of the Windows ADS server ADSSERVER ADSDOMAIN LOCAL Therefore the windows server is named ADSSERVER the realm is ADSDOMAIN LOCAL and the workgroup name is ADSDOMAIN FQDN of the Zarafa Server is ZARAFA LINUXDOMAIN LOCAL In this example the Zarafa Server is placed in a different do
129. on 8 8 Address lists by condition for more information on how to administer address lists 5 3 6 Testing Active Directory configuration After the LDAP configuration is done the changes can be activated by reloading the Zarafa Server etc init d zarafa server reload To test users and groups will be listed use 49 Chapter 5 Configure 3rd Party Components zarafa admin 1 and zarafa admin L If no users or groups are shown please check the Zarafa server log file for errors Setting the loglevel to 6 in the etc zarafa server cfg will display all LDAP queries by the Zarafa server and possible errors The first time the zarafa admin 1 is done all mailboxes will be created This can take some time so be patient More information about the other available LDAP attributes can be found in the man page man zarafa ldap cfg See Chapter 8 User Management for Zarafa user management with Active Directory 5 4 ZCP Postfix integration ZCP does not include it s own MTA but can be integrated all established MTAs found in modern Linux distributions Although ZCP support most Linux MTAs we advise to use Postfix In order to deliver an email into a user s mailbox the zarafa dagent is executed Messages are passed to the zarafa dagent from the standard input or by the LMTP protocol A few examples of the ZCP Postfix integration are described in the following sections Keep in mind that Postfix is very flexible so many differ
130. ore For all items found write them to disk Because it first creates a list of everything in the store newly created items during the backup will not be seen and thus will not be backed up Moved items will still be in the backup but in the original location they were found in Hard deleted items during the backup will not be backed up because they cannot be opened anymore When the backup is started again it will find the previous backup and automatically start an incremental backup and will perform the following actions Read the index file and create a tree of the previous backup Create a list of all the folders and their contents of the store Per container find the items which are already backed up and did not change and remove those from the list 105 Chapter 10 Backup amp Restore Remove the old index file Backup the items left in the list and append them to the data file To start the backup process use zarafa backup u username or for all users and public folders zarafa backup a There are a few things to notice about this behavior of the backup tool When the lists of the previous index and the current contents of the store are compared it does this per matching container This means that if the user moved items from one folder to another they will not be found thus will be backed up again because they will be marked as new in the other folder they we re moved to If a message was change
131. r 38 Chapter 5 Configure 3rd Party Components 5 1 Configure the Webserver Normally the Zarafa package will configure PHP on the system automatically In most situations this chapter can be skipped and continued with Section 5 1 2 Configure Apache 5 1 1 Configure PHP PHP is needed in order to use WebAccess The PHP extension is installed in the default directory of distribution Red Hat Enterprise Linux usr 1ib php4 or usr 1ib php5 e SLES OpenSUSE usr lib php extensions e Debian usr 1ib php5 20060613 Ubuntu usr 1ib php5 20060613 If a different directory for PHP extensions has been selected move the mapi so files to this location eg mv usr lib php mapi so usr local lib php To find the PHP extensions location use the following command php config extension dir After the PHP extension is in the correct directory add it to the php ini configuration file Add the following line to the php ini if it does not already exist extension mapi so Common places for the php ini file are etc php ini etc php5 apache2 php ini With the phpinfo function it is possible to check whether the module will be loaded correctly Search for the MAPT part to check for the module The phpinfo can also be viewed by running php ion the command line if php cli is installed 5 1 2 Configure Apache To correctly load the recently added mapi so extension the webserver needs
132. r Mobile Devices This chapter describes how to configure the Z Push software to bridge ZCP with ActiveSync enabled PDAs and smartphones Z Push is available as an open source project on Sourceforge http z push sourceforge net In this manual only the server part of Z Push is discussed please refer to our User Manual for instruction on configuring mobile devices Mobile phones smartphones and PDAs can be synchronized because Z Push emulates the ActiveSync functionality of a MS Exchange server on the server side allowing mobiles to synchronize 54 Compatibility via over the air ActiveSync AirSync Using Z Push most mobiles can synchronize without installing any additional software on the device Z Push needs to be installed on a web server It is highly recommended to use Apache 5 5 1 Compatibility Z Push allows users with PDAs and smartphones to synchronise their email contacts calendar items and tasks directly from a compatible server over UMTS GPRS WiFi or other GSM data connections The following devices are supported by Z Push e Windows Mobile 5 6 6 1 and 6 5 Nokia E N series with Mail for Exchange M4E Nokia E series with built in ActiveSync Nokia Mail 2 Sony Ericsson with RoadSync Apple iPhone Android Cupcake or Donut with third party tools like Nitrodesk Touchdown Android Eclair with Contacts and Calendar synchronization or third party tools other ActiveSync compatible devices For d
133. r plugin As mentioned above the Global company quota and Global user quota can be configured in the etc zarafa server cfg file in there the options quota warn quota soft and quota hard for the user quota and the options companyquota warn for the tenant quota To configure the Specific company quota the zarafa admin tool can be used when using the DB plugin The following command will set the various quota levels over the tenant zarafa admin update company tenant qo y qw warningquota To configure the Specific user quota the zarafa admin tool can be used when using the DB plugin The following command will set the various quota levels over the user zarafa admin u user qo y qh lt hardquota gt qs softquota qw lt warningquota gt To configure the Company user quota the zarafa admin tool can be used when using the DB plugin by using the update company argument The following command will set the various user default quota levels over the tenant zarafa admin update company tenant udqo y udqh hardquota udqs softquota udqw warningquota 64 Multi server setup When using the LDAP plugin the attributes which control the quota levels can be configured in etc zarafa ldap cfg 6 3 Multi server setup This chapter will provide information regarding the multi server functionality which was introduced in Zarafa 6 30 Note In order to use this feature a valid Zarafa E
134. rafa zarafa linuxdomain localQADSDOMAIN LOCAL mapuser EXAMPLE zarafa linux crypto DES CBC MD5 ptype KRB5 NT PRINCIPAL mapop set desonly pass a out c keytab zarafa Copy the file keytab apache to etc httpd conf on the Linux server Copy the file keytab zarafa to etc zarafa on the Linux server 6 7 3 3 Kerberos configuration Open the file etc krb5 conf and insert the following lines 1ibdefaults default realm ADSDOMAIN LOCAL realms ZARAFA LOCAL kdc adsserver adsdomain local admin server adsserver adsdomain local domain_realm adsdomain local ADSDOMAIN LOCAL adsdomain local ADSDOMAIN LOCAL Configuring ZCP for Kerberos SSO with Outlook Add the following line to the 1ibdefaults section of etc krb5 conf default keytab name etc zarafa keytab zarafa 6 7 3 4 Zarafa Server configuration To enable Outlook SSO with ZCP set the following in the server cfg file 80 SSO with Kerberos enable_sso yes If the hostname of the Linux server see the hostname command does not equal the FQDN of the Linux server the server hostname variable will need to be changed in the server cfg file server hostname zarafa linuxdomain local Restart the zarafa server to activate all changes service zarafa server restart 6 7 3 5 Apache configuration for SSO with WebAccess Install the mod auth kerb Apache module e g for Red Hat yum install mod auth kerb Open the file etc httpd con
135. re usually enough in line comments explain each option In this configuration file the uid range of users wanted in the Zarafa server needs to be defined The same goes for the groups Non active users are appointed by a specific shell default bin false These users cannot login but the stores can be opened by other users An administrator should setup the correct access rights for these stores An overview of all the configuration options of the unix authentication plugin type man zarafa unix cfg 4 2 1 3 The LDAP Authentication Plugin The LDAP plugin is used for coupling any LDAP compliant server with the Zarafa Server This way all users groups and membership information can be retrieved live from an LDAP server The LDAP plugin support next to the default users groups and companies also the following object types Contacts External SMTP contacts which can be used as members of distribution lists Addresslists Sub categories of the Global Address Book based on a specified LDAP filter Dynamic groups Dynamically created groups based on a specified LDAP filter Therefore LDAP plugin is the recommended user plugin for ZCP The Zarafa Server needs two configuration directives in the server cfg configuration file to use the LDAP backend namely user plugin ldap user plugin config etc zarafa ldap cfg The defaults for OpenLDAP and for Active Directory can be found in the usr share doc zarafa exampl
136. rom the OpenLDAP server The specified bind user should at least have read access on the LDAP server ldap bind user cn Manager dc zarafa dc com 41 Chapter 5 Configure 3rd Party Components ldap bind passwd secret ldap authentication method bind The authentication method can be set to password so the Zarafa Server will compare the encrypted password from the LDAP server with the encrypted password the user filled in during the login For the method the specified bind user has to be an administrative user in OpenLDAP and have read access on the password attribute The LDAP search base base DN that the search for the different objects should start at This should be the root of the LDAP directory which contains the users groups and contacts ldap search base dc zarafa dc com ldap object type attribute objectClass ldap user type attribute value posixAccount ldap group type attribute value posixGroup ldap contact type attribute value zarafa contact ldap company type attribute value zarafa company ldap addresslist type attribute value zarafa addresslist ldap dynamicgroup type attribute value posixGroup zarafa dynamicgroup Based on the type attribute the Zarafa Server will created an object in the database and listed in the Global Address Book Make sure that the values are always unique for one type of object 5 2 3 User configuration Normally a user store is created for each object in the LD
137. rver processes to activate this change e g for Red Hat service zarafa server restart 6 7 3 7 Browser configuration Before Single Sign On can be used in a browser configure the following settings Firefox 1 Type in the addressbar about config 2 Filter on auth 3 Change the options network negotiate auth trusted uris and network negotiate auth delegation uris to testdomain com Internet Explorer 1 Goto Tools gt Internet options gt Advanced 2 Make sure the option Enable integrated Windows authentication is enabled 3 Add the url of the Zarafa Server hitp zarafa linuxdomain local to the Local Intranet sites Restart the browser and open the WebAccess via the FQDN http zarafa linuxdomain local webaccess If the configuration is done correctly the user will be logged in to the WebAccess without typing the username and password 6 7 4 Up and running Now that SSO seems to work with the Linux server it will automatically be used by zarafa server Now log on to a Windows workstation on the domain and create a new Outlook profile for the user just logged on but leave the password field empty Outlook should create the profile without the password 82 Chapter 7 Managing ZCP Services 7 1 Starting the services There are 7 services that can be run zarafa server the server process zarafa spooler sends outgoing email to an SMTP server zarafa monitor checks for quota limits zarafa gatew
138. s Zarafa This will make 92 Setting up the LDAP repository sure that the local LDAP server will always be reachable and Zarafa will always keep running as normal 8 5 5 Setting up the LDAP repository While in principle almost any LDAP repository can be used with Zarafa this document describes how Zarafa requests the data from the server and how that data is used within the Zarafa server and tools The following information is required from the LDAP server User details name email address etc Contacts name email address Group details name of group Company details User Group relationships group membership Company members users and group membership Company relationships cross company view and administrator permissions The objects that are classified as users contacts groups dynamic groups addresslists or companies and the attributes that contain the data can be configured within the Zarafa configuration files so Zarafa can meet the LDAP schema needs However here are some pointers to keep the LDAP repository clean and easy to manage Always use some sort of graphical user interface for user and group management There are many LDAP configuration tools For example phpLDAPadmin for OpenLDAP as a web based interface If there are users that will be using Zarafa while other users will not try to group these users into separate folders An OU record or any other dc type object ca
139. server Besides performance improvements it also allows the Zarafa Server to run even when the main LDAP server goes down In the follow paragraphs the configuration will be explained Check the location of the the configuration files before changes are made OpenLDAP configuration is usually located in etc depending on the used distribution it is Red Hat Enterprise Linux etc openldap SUSE etc openldap Debian amp Ubuntu etc ldap Through out this guide we use etc openldap 5 2 1 Configuring OpenLDAP to use Zarafa schemas To configure openldap to use Zarafa LDAP schemas the following configuration directives need to be added to etc openldap slapd conf include etc openldap schema zarafa schema Copy the schema file to the Idap directory cp usr share doc zarafa zarafa schema etc openldap schema zarafa schema 5 2 2 Configuring ZCP for OpenLDAP To integrate ZCP with an OpenLDAP server change the following option in the ldap cfg configuration file Specify in the 1dap host option the ip address or server name of the LDAP server ldap host 192 168 0 1 At the moment ZCP doesn t support the configuration of multiple LDAP servers By default the plain LDAP protocol will be used For configuring secure LDAP change the following settings A howto for configuring OpenLDAP with SSL certificates can be found on http wiki zarafa com ldap port 389 ldap protocol ldap The Zarafa Server will only read f
140. specifying multiple Active Directory servers here However it is possible to point the 1dap host to an Active Directory load balancer By default the plain LDAP protocol will be used For configuring secure LDAP change the following settings ldap port 636 ldap protocol ldaps A guide for configuring Active Directory with SSL certificates can be found in an article on our wiki The Zarafa Server only reads from and never writes to the LDAP or Active Directory server Therefore the specified bind user should at least have read access on the LDAP server ldap bind user cn administrator cn users dc zarafa dc com ldap bind passwd secret 1 http www zarafa com wiki index php Configure_Active_Directory_with_SSL 47 Chapter 5 Configure 3rd Party Components ldap authentication method bind The LDAP search base base DN specifies a branch that the Zarafa Server with limit itself to This should be the root of the LDAP directory which contains the users groups and contacts ldap search base dc zarafa dc com By the following type attributes the Zarafa Server knows what objects to create in the database and what to list in the Global Address Book Make sure these values are all unique ldap object type attribute objectClass ldap user type attribute value User ldap group type attribute value Group ldap contact type attribute value Contact ldap company type attribute value ou ldap addressli
141. ssl certificates sh client Again when entering the certificate details at least make the Organizational Unit Name different from the other certificates Also do not forget to fill in the Common Name field When asked for the creation of the public key enter y and press enter Now a new certificate called client pem and a public key called client public pem are present As an example the configuration options needed to edit on the dagent cfg file are as follows server_socket https name or ip address 237 zarafa sslkey file etc zarafa ssl client pem sslkey pass ssl client password Enter the correct name or IP address in the server socket option If Another port number for the SSL connections on the server is used enter the right port number as well Replace the password with the password used while creating the certificate Copy the client public pen file to the server location mkdir etc zarafa sslkeys mv client public pem etc zarafa sslkeys Now the client knows the private key and the server knows the public key The client can login with this key to the server from anywhere on the network or internet Note Be careful with the client pem file Anybody who has this private key can login to the Zarafa server and will be the internal SYSTEM user who can do anything without restriction 6 2 Multi tenancy configurations This section will provide information regarding the multi tenancy functionality whi
142. st type attribute value zarafa addresslist ldap dynamicgroup type attribute value zarafa dynamicgroup 5 3 3 User configuration which have specified user type attribute an additional search filter can be specified For example ldap user search filter zarafaAccount 1 All user related fields can be mapped by the following options ldap user unique attribute objectGUID ldap user unique attribute type binary ldap fullname attribute cn ldap loginname attribute sAMAccountName ldap emailaddress attribute mail ldap emailaliases attribute otherMailbox ldap password attribute ldap isadmin attribute zarafaAdmin ldap nonactive attribute zarafaSharedStoreOnly The unique user attribute is the mapping between a mailbox in the database and the actual user Make sure this field can never be changed otherwise a user deletion will be triggered by the Zarafa Server The email aliases are shown in the Global Address Book details and can be used for email aliases in Postfix However it s not possible to deliver email to email aliases Extra user information like addresses phone numbers and company information can be mapped by an extra configuration file include etc zarafa ldap propname cfg The specified attributes for users will also be used for the contacts 5 3 4 Group configuration The groups can be as well filtered by an extra search filter 48 Addresslist configuration ldap group search filt
143. t company lt companyname gt This command can be combined with the option qw for setting the quota warning level for the specified company space To control the view privileges for company spaces the following commands can be used usr bin zarafa admin add view viewer I lt companyname gt usr bin zarafa admin del view viewer I lt companyname gt usr bin zarafa admin list view I lt companyname gt The viewer is the companyname which receives or looses permission to view company lt companyname gt With the view privileges the Global Address Book can be shared between multiple organizations or use cross organization mailbox delegation usr bin zarafa admin add admin admin I lt companyname gt usr bin zarafa admin del admin admin I lt companyname gt usr bin zarafa admin list view I lt companyname gt The admin is the loginname of the user who receives or looses admin privileges over the company lt companyname gt 6 2 4 Managing users and groups When using the DB plugin users and groups should be created using the zarafa admin tool For details about using the zarafa admin tool see man zarafa admin The user or group name that should be given to the zarafa admin tool depends on the loginname_format configuration option For example when loginname format is set to u c creating a user for tenant exampleorg would be usr bin zarafa admin c johnQexampleorg other optio
144. tart of each general release cycle like 6 x x or 7 x x we decide what plaforms we support Usually that means the current release of that platform and the most recent previous release During the major release cycle supported platforms can be added but not removed Please use the x86 64 or 64bit packages if 64bit hardware and OS are available It is recommended to run on 64bit whenever possible OS Release Supported CPU Architectures RHEL 4 i386 x86_64 ia64 RHEL 5 i386 x86_64 ia64 RHEL 6 i686 x86_64 SLES 10 i586 x86_64 ia64 SLES 11 i586 x86_64 ia64 Debian 4 0 Etch i386 x86_64 ia64 Debian 5 0 Lenny i386 x86_64 ia64 Debian 6 0 Squeeze i386 x86_64 Ubuntu 6 06 LTS Dapper i386 x86_64 Chapter 2 Installing OS Release Supported CPU Architectures Ubuntu 8 04 LTS Hardy i386 x86 64 Ubuntu 10 04 LTS Lucid i386 x86 64 Table 2 2 Supported platforms for ZCP s back end components deprecated support for the ia64 architecture will be dropped in the ZCP 7 x x cycle deprecated support for these distributions will be discontinued from ZCP 7 0 0 onward beta these distributions are in development and will be fully supported once released We currently build packages for SUSE 9 1 i568 10 0 i568 and 10 2 i568 and x86 64 which we do not officially support These packages are deprecated from ZCP 7 0 0 onward we will no longer build for these version o
145. tc zarafa scripts attachments parser but the exact location can be configured using the configuration option index attachment parser The script attachments parser will use the file attachments parser db to decide how the attachment should be parsed to plain text Within this file is a list containing the command to parse each attachment type to plain text This file can be edited to control the way attachments are parsed and to add or remove support for particular attachment types The layout of each line is as followed mime type extension command Each line can have as many mime types and extensions as needed each mime type and extension must be separated using semi columns The command must read dev stdin for the attachment data and must return the plain text through dev stdout Some tools cannot parse attachment data from a stream and require the data to be provided as file To store the attachment in a temporary file the script zmktemp can be used That script will write all attachment data in a temporary file and print the location of the file to dev stdout Attachments which cannot be parsed for example images the command echo n can be used After editing the command it is advisable to test it to see if the desired output is returned Testing the command can be done by executing the following command on the command line cat attachment command The resources used by the attachments parser during the
146. ter service Zarafa server Zarafa Launcher application Zarafa server machine PC with Zarafa Client Figure 6 8 Auto update structure The Launch Updater application will be launched at Windows startup The command to run the application is placed in the registry here HKEY_LOCAL_MACHINE Sof tware Microsoft Windows CurrentVersion Run This application will find out client s current version from the following registry key 73 Chapter 6 Advanced Configurations HKEY LOCAL MACHINENSoftwareNZarafaNClientNVersion This is a new registry key introduced for updater mechanism it will contain the version of the Zarafa Windows Client installed on the machine The Launch Updater application will read default Outlook profile from the registry to gather the credentials needed to connect to the Zarafa Server It informs the Zarafa Server which version of the Zarafa Windows Client is running the Zarafa Server responds with a newer Zarafa Windows Client in case that exists 6 4 2 1 Zarafa Updater Service The zarafa updater service runs as a local system account Therefore it has all the needed privileges to install the Zarafa Windows Client on the desktop 5 Services EEx Fie Action view Help e m FAR RM gt m i mw Sy Services Local Name Description Status Startup Type Log On s Sa Windows Manageme Provides systems ma Manual Local System amp amp Windows Media Playe Shares Windows Medi Man
147. the server ssl ca file setting The server certificate and password must be set in the server ssl cert fileand server ssl cert pass options server ssl ca file etc zarafa ssl demoCA cacert pem server ssl key file etc zarafa ssl server pem server ssl key pass password Restart the zarafa server process and now it s possible to connect directly to the SSL port Create a new Outlook profile and mark the SSL connection option Set the port to 237 The connection to the server has now been encrypted 4 3 Configure the License Manager Note With the ZCP community edition the License Manager is not needed The License Manager zarafa licensed expects etc zarafa license to contain a file named base which simply holds the license key To install a license key use the following command mkdir p etc zarafa license echo lt license key gt gt etc zarafa license base lt license key gt should be replaced with a valid license key obtained from Zarafa or one of its partners Note The license key consists only of numbers and capital letters 25 Chapter 4 Configure ZCP Components If an extra CAL Client Access License is also available the license key can be added with echo CAL key gt etc zarafa license cal1 If more than one CAL are available please install one CAL per file in the license directory The filename of the CAL is of no importance Sub folders in the etc zarafa license folder are not allowe
148. ther events can be scripted by the system administrator This means that by default no actions are performed during group creation and group deletion 8 5 3 Group membership Zarafa synchronises users groups and companies so that it can assign user ID s to them but the group membership for users is never stored on the Zarafa server This means that group membership changes are real time also and the Zarafa server will query group membership for a user or a user list for a group directly from the LDAP server How the mapping between group members and users is done will be discussed later 8 5 4 LDAP server dependency Due to the fact that the Zarafa users database doesn t actually hold the user or group information but only a reference to the LDAP server the Zarafa server cannot function without a running and accessible LDAP server If the LDAP server goes down while Zarafa is running Zarafa tools will not be able to perform any actions as almost all server side actions require some kind of interaction with the LDAP server For example just opening an email requires a query to the LDAP server for the groups that the current user has been assigned to Only after fetching this information can Zarafa determine whether the current user has the access rights to open the message When using OpenLDAP as an LDAP source LDAP replication to guarantee that an LDAP server is available at all times by running an OpenLDAP server on the same machine a
149. to be restarted The following example shows how to restart Apache2 etc init d apache2 restart 39 Chapter 5 Configure 3rd Party Components or etc init d httpd restart The website files are by default installed in the WebAccess directory Make sure the webclient s login page can be opened by browsing to the correct url http lt ip address server gt webaccess If the login page is not shown the webserver needs to be configured to let it access the correct directory The following example shows a configuration for Apache2 Alias webaccess usr share zarafa webaccess lt Directory usr share zarafa webaccess gt AllowOverride None Order allow deny Allow from all lt Directory gt Make sure the correct directory holding the PHP WebAccess files is typed The following command will tell apache2 to reread its config file etc init d apache2 reload The WebAccess should now be visible If it still does not show up please see Section 2 3 Troubleshooting Installation Issues for more information 5 1 3 Apache as a HTTP Proxy The transmitted data between the client and server is compressed XML wrapped in HTTP packets The use of HTTP allows packets to be forwarded a proxy or a webserver with built in proxy functionality for example Apache version 2 The following lines are an example of how Apache can be configured to forward incoming connections on port 80 to the Zarafa Server on port 236 When the Apach
150. to have the different company in the LDAP tree and below every company container the users groups and contacts within that specific company It s not possible to assign a user to a specific company by an LDAP attribute See the screenshot below for an example LDAP structure A de zarala dc com 192 168 122 185 Attribute Value ou Hosted customers objectClass top 2 m ou Company objectClass organizational nt 3 cn Sales objectClass Zaata company A uidsjohn ou Company BH ousCompany B x ousCompany C cn Manager Figure 6 1 LDAP tree multi tenant environment Change the following lines in the LDAP configuration file to configure the multi tenancy support ldap company unique attribute ou ldap companyname attribute text ldap company scope sub Test the settings by using zarafa admin list companies and zarafa admin 1 If no companies or users are shown please check the Zarafa server log file for errors Setting the loglevel to 6 in the etc zarafa server cfg will display all LDAP queries by the Zarafa server and possible errors With multi tenancy support enabled it s not only possible to have different organizations on a single server but also more advanced settings can be configured like cross organization mailbox delegation different administrator levels and organization quota levels See the zarafa ldap cfg man page for more detailed information about these multi tenancy LDAP features
151. tore will be kept in the database but is not accessible Note In ZCP 6 30 6 and earlier versions the store of the user will be moved to the Deleted Stores folder in the public store This folder is only available for administrative users Administrators can browse the folders or delete the deleted stores completely by removing the corresponding folder from the Deleted stores folder This is relevant for all user plugins Use the following command to retrieve a list of stores without a user and users without a store 88 Send as Permissions usr bin zarafa admin list orphans It can be decided to remove the store from the database or hook the store to another user to be able to access it once again To remove the store from the database an action which is irreversible use the following command usr bin zarafa admin remove store lt store guid gt To hook the store to another user use the following command usr bin zarafa admin hook store lt store guid gt u lt user gt The user given with the u option will now have the new store attached to it Re login with the webaccess or create a new profile in Outlook to be able to access the store Important When a store is hooked to a user that already has a store attached to it the original store will be orphaned This original store can be found using the 1ist orphans options of the zarafa admin command 8 2 5 Send as Permissions ZCP
152. ttachments as stored in the lob table During the upgrade a temporary table to store all attachments is created and removed since it is not possible to shrink the database storage file it will grow by the combined size of the attachments stored in it Information on migrating the attachments from the database to the file system can be up found o Note When upgrading a licensed version of ZCP to a new major release like from 6 30 x to 6 40 x the license key has to be converted Converting license keys is performed on ae 3 2 Creating backups Now create backups of the database and configuration files Make a copy of the etc zarafa which contain the configuration files cp r etc zarafa etc zarafa bck To backup the MySQL database an mysqldump can be executed mysqldump single transaction p zarafa gt zarafa sql 15 Chapter 3 Upgrading or the complete mysql data directory can be copied etc init d mysqgld stop cp r var lib mysql var lib mysql bck 3 3 Performing the Upgrade After the backups have been created the upgrade can be performed similarly to how a package would be installed manually For RPM based installation that is rpm Uvh package name gt or for Debian based installations dpkg i package name Start with libvmime libical and zarafa in this order then install other Zarafa packages as seen fit Note In the community edition the package zarafa licensed is not need
153. ual Network 5 amp amp Windows Presentatio Optimizes performanc Manual Local Service By Windows Search Provides content inde Started Automatic Local System Siy Windows Time Maintains date and ti Started Automatic Local System Bs Wired AutoConfig This service performs Manual Local System amp amp Wireless Zero Config Provides automatic co Started Automatic Local System Bo WMI Performance Ad Provides performance Manual Local System amp amp Workstation Creates and maintain Started Automatic Local System Zarafa Updater Service This service will updat Started Automatic Local System Figure 6 9 Services The zarafa updater service will wait on a pipe for Zarafa launch updater application to send it the current version of the client and the details of the Zarafa Server to connect to If there is a suitable update the service downloads it to c windows temp zarafaclient msi The zarafa updater service launches this update for installation in a silent mode Although the entire update process is silent logs can be generated for troubleshooting To generate logs the updater service startup parameter needs to have v option similarly for the launcher the registry key needs to have the variable v The Updater service log will be written in the A11 users Application dataw directory and the Launch updater log will be written in the user Application dataw directory Note The client will only fin
154. ulti tenancy To enable multi tenancy support in Zarafa change the following configuration option in server cfg enable_hosted_zarafa yes 6 2 2 2 Configuring login name The loginname of a user must be unique in order to correctly allow the login attempt When enabling multi tenancy support in Zarafa having an unique loginname can become difficult as the number of companies tenants increases It is easier when the loginname contains the companyname as well to ensure all loginnames are unique The way the companyname is attached to the username to create the loginname can be configured with the loginname_format configuration option in server cfg This configuration option can contain the following variables 60 Configuring the server u The username c The companyname to which the user belongs As separation character between the username and companyname a character should be chosen that does not appear inside the username or companyname itself Valid characters for example are and N Some example loginname format for a user named John Doe who is member of Exampleorg u john u c gt johnGexampleorg c u gt exampleorg john Although having a loginname that contains a c is mandatory for the DB plugin it is optional for the LDAP plugin Managing unique oginname s is easier in LDAP because it is possible to use the email address as the loginname attribute See the LDAP configuratio
155. users are a member of the group Everyone When a new Zarafa user is created only the free busy information is open for read access for the group Everyone by default 8 3 1 Creating groups using zarafa admin By using the zarafa admin tool groups can be created and users can be added or removed from groups In the following example a user john is created a group administration is created and the user john is added to the group administration zarafa admin c john p secret f John Doe e j doe domain com zarafa admin g administration zarafa admin b john i administration Using the options 1 or L a list of users or groups can be listed from the server When listing users everyone will always be in the group Everyone 8 4 Other admin commands The zarafa admin tool can also be used to list users and groups retrieve user details and set user specific quota levels Please refer to the manual page of zarafa admin to see all the commands and options available 90 User Management with LDAP or Active Directory man zarafa admin 8 5 User Management with LDAP or Active Directory The Zarafa server features a system whereby the administrator of a server can specify an LDAP based server to retrieve user group and company information This means that user management can be simplified for installations and standard LDAP administration tools can be used for user management Also using an LDAP server makes
156. ver and the authentication credentials for its database It will create a database and the tables it needs at first start Make sure that the MySQL user that the Zarafa Server uses to connect to the database has all privileges including the right to create a new database The privilege to create databases could be revoked after the database has been created by the server Also make sure to give the user enough permissions to connect from localhost to this database or if the Zarafa server connects over the network to the MySQL database allow it to connect from the IP address from which the Zarafa Server will connect For example the following MySQL statement grants all privileges to user zarafa with password password from localhost GRANT ALL PRIVILEGES ON zarafa TO zarafa Q localhost IDENTIFIED BY password To configure the Zarafa Server to use the MySQL server the options starting with mysql in the zarafa server cfg need to be set Once this is setup the Zarafa Zerver should start normally 19 Chapter 4 Configure ZCP Components 4 2 Configure language After the creation of a new users the Zarafa Server will automatically create the actual mailbox This mailbox is by default created in the language of the Linux server When another language is required the following configuration file has to be changed etc sysconfig zarafa Or on Debian and Ubuntu based systems etc default zarafa Change the option ZARAFA US
157. want to use a password for the server key If a password is set then this password is needed later on to sign certificate requests Then enter the certificate information Give extra attention to the Common Name This has to be the fqdn of the server The challenge password at the end may be left empty At the end of the certificate creation the certificate need to be signed against the CA Accept twice the question for the signing and fill the password of the CA again when asked for In the last step the script will ask if it should display the public key of this certificate This is not necessary since the certificates have already been created After completing the ssl certificates sh script the server certificate is created in the current directory The root CA certificate can be found in the same directory or in the default SSL directory of the Linux distribution On Ubuntu the root CA will be created as demoCA cacert pem on RedHat the root CA will be created as etc CA cacert pem Edit the following lines in etc zarafa server cfg server ssl enabled server ssl port server ssl ca file server ssl key file server ssl key pass sslkeys path yes 237 etc zarafa ssl demoCA cacert pem etc zarafa ssl server pem ssl password etc zarafa sslkeys After a restart of the Zarafa server the server should accept HTTPS connections Please check the server logfile for any errors If the server certificates are successfully created
158. when using OpenLDAP 3 Add new attribute ZarafaSendAsPrivilege in OpenLDAP 4 Find the usernames of the users that should be able to sendas this user 5 Add the uid in OpenLDAP or add the DN of the user in Active Directory to the attribute ZarafaSendAsPrivilege 6 Edit when using OpenLDAP the 1dap cfg and edit if needed the values ldap sendas attribute zarafaSendAsPrivilege ldap sendas attribute type text ldap sendas relation attribute uid The user that has the sendas permissions should now be able to add the other address in the FROM field and sendas this account Since ZCP 6 40 the sendas system is changed Configuring the sendas permissions is the other way around than previous Zarafa versions Sendas permissions now have to be configured on the user which is select as the FROM address e See Section 3 3 1 From 6 30 to 6 40 for converting the sendas permissions Groups can now also be used for setting sendas permissions Contacts which for example have an external SMTP address can also be configured with sendas permissions 8 7 Hide information from Global Address Book From ZCP 6 40 it s possible to hide users contacts or groups from the Global Address Book Hiding information from the Global Address Book can be done by the checkbox Hide from addressbook option in the Zarafa tab in Active Directory or by setting the zarafaHidden attribute in OpenLDAP to 1 94 Address lists by condit
159. which provides basic web E http z push sourceforge net Chapter 1 Introduction interface with limited functionality Please note that this component is deprecated and will probably be removed from future version of ZCP 1 4 Protocols and Connections All applications which directly connect to the Zarafa Server use MAPI in SOAP to do so see the Architecture Diagram Even the WebAccess uses MAPI in SOAP provided by the PHP MAPI extension to connect to the Zarafa Server The Zarafa Windows Client is a standard Microsoft Windows compatible MAPI provider It connects to the server MAPI in SOAP over the HTTP S protocol 1 4 1 SOAP SOAP is an abbreviation of Simple Object Access Protocol It is a protocol to exchange data and make Remote Procedure Calls between applications over a network or Internet for that matter SOAP is based on XML and HTTP 1 1 port 80 or port 443 in case of HTTPS Because of these standards it is possible to connect transparently through proxies allowing connectivity over most networks without modifications 1 4 2 Secure HTTP HTTPS The Zarafa Windows Client has the possibility to connect to the server over HTTP secured with SSL HTTPS When a MAPI profile from Outlook is created it is possible to set the connection to use HTTPS All connections over the network will then be encrypted making eavesdropping virtually impossible The Zarafa Server must be configured to also accept SSL connect
160. with sh install sh After running install sh the server should be ready to start Proceed with creating stores as explained by the script In case the install sh script is invoked with the config parameter it will not install any software but ask the configuration options only sh install sh config The install sh script always configures the server to use the DB user plugin If another user base is neccesary please read Chapter 4 Configure ZCP Components for information on how to configure the server Note If an older version of ZCP is installed please read C install sh script is not usable in this case 2 2 3 Manually Installing Packages Please use the packages for the distribution used See the distribution list in Section 2 1 2 Supported Platforms For other distributions it is possible to use the packages for a distribution that is the most similar but keep in mind Zarafa cannot support those installations Note Do not mix packages of different distributions Choose one distribution and use only those packages If this rule is not honored errors will occur 2 2 3 1 RPM based distributions Use the following command to install the ZCP packages on RPM based distributions rpm Uvh lt package file gt Replace lt package file gt with the packages found in the tarball Start with Libvmime libical and zarafa in this order then install the other packages The package manager might find unresolved
161. www z push state The user and group name of Apache will differ per Linux distribution The table below shows an overview of the user and group names of the Apache process Distribution Apache username Groupname Red Hat Enterprise Linux apache apache OpenSuSE and SLES wwwrun www Debian and Ubuntu www data www data Table 5 2 User and groupnames per distribution Now Apache must be configured to redirect the URL Microsoft Server ActiveSync to the index php file in the z push directory This can be done by adding the line to the httpd conf file Alias Microsoft Server ActiveSync var www html z push index php Make sure that the line is added to the correct part of the Apache configuration taking care of virtual hosts and other Apache configurations Important It is not possible simply rename the Z Push directory to Microsoft Server ActiveSync This will cause Apache to send redirects to the PDA which will definitely prevent proper synchronization Lastly make sure that PHP has the following settings php flag magic quotes gpc off php flag register globals off php flag magic quotes runtime off php flag short open tag on Set this in the php ini or in a htaccess file in the root directory of Z Push If not setup correctly the PDA will not be able to login correctly via Z Push Reload Apache to activate these changes 5 5 4 Mobile Device Management Users can remote wipe own mobile devi
162. xtra search filter as well ldap group search filter ldap group unique attribute gidNumber ldap group unique attribute type text For the membership relationships between groups and users each group object has a group member attribute This can be configured by ldap groupmembers attribute memberUid The Zarafa Server will by default use the unique user attribute as value of the group member attribute This can be changed by the group member s relation attribute ldap groupmembers attribute type text ldap groupmembers relation attribute uid Groups can be flagged as security groups by the security group attribute Security groups are available in the Global Address Book when creating a new email and setting permissions To achieve this the attibute here zarafaSecurityGroup must be set to 1 When the zarafaSecurityGroup attribute is set to 0 the group will be a distribution group Distribution groups are only available in the Global Address Book when creating a new email but cannot be used for configuring mailbox permissions ldap group security attribute zarafaSecurityGroup ldap group security attribute type boolean 5 2 5 Addresslist configuration Addresslists are groups of users that match a custom condition These addresslists are shown as sub folders in the Global Address Book Address Book Type Name Show names from the 3 Global Address Book iw Global Address Book Administration B
163. y The zarafa spooler may take up to 10 seconds to stop The zarafa server may take up to 60 seconds to stop 83 Chapter 7 Managing ZCP Services 7 1 2 Reloading service configuration Some options can be modified and reloaded by the service in a live environment The options that can be reloaded are described in the manual page of the service configuration file Example for the zarafa server type the following command to get the configuration manual page man zarafa server cfg In the reloading chapter are all the options that can be reloaded for that service To make a service reload the configuration file type etc init d zarafa lt servicename gt reload 7 2 Logging options Each component allows the log method to be chosen in its configuration file Two ways of logging methods are supported file and syslog Normally all ZCP components log to their respective file located in var log zarafa This directory is created when the packages are installed When this directory is not present or not writable under the running user services will not be able to open their log file and will print the log messages to the standard output Log messages of the server can be configured The following options need to be altered in the configuration file log method How to log the messages file sends the messages to a file On Linux systems syslog sends the messages to the default maillog through syslog log file When the l

Zarafa Collaboration Platform - The Administrator - NIT

Contents

Download Pdf Manuals

Related Search

Related Contents