Product SiteDocumentation Site

ZCP 6.40 (build 22052)

Zarafa Collaboration Platform

The Administrator Manual

Edition 2.0

The Zarafa Team


Legal Notice

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.
Abstract
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 advanced 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.

1. Introduction
1.1. Intended Audience
1.2. Architecture
1.3. Components
1.4. Protocols and Connections
1.4.1. SOAP
1.4.2. Secure HTTP (HTTPS)
1.5. ZCP Editions and Licensing
1.5.1. The Trial License
1.5.2. The ZCP Community Edition
1.5.3. Commercial Editions of ZCP
1.5.4. Active and non-active users
2. Installing
2.1. System Requirements
2.1.1. Hardware Recommendations
2.1.2. Supported Platforms
2.1.3. Dependencies
2.2. Installation
2.2.1. Installing ZCP with a Package Manager
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
3. Upgrading
3.1. Preparing
3.2. Creating backups
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
4.2.4. SSL connections and certificates
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/TLS
4.5.2. Calendar access
4.6. Configure Zarafa Gateway (IMAP and POP3)
4.6.1. SSL/TLS
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
4.7.4. Quota warning templates
4.8. Configure Zarafa Indexer
4.8.1. Enabling indexing service
4.8.2. Users, companies and servers
4.8.3. Indexer configuration
4.8.4. CLucene configuration
4.8.5. Attachments
5. Configure 3rd Party Components
5.1. Configure the Webserver
5.1.1. Configure PHP
5.1.2. Configure Apache
5.1.3. Apache as a HTTP Proxy
5.2. Configure ZCP OpenLDAP integration
5.2.1. Configuring OpenLDAP to use Zarafa schemas
5.2.2. Configuring ZCP for OpenLDAP
5.2.3. User configuration
5.2.4. Group configuration
5.2.5. Addresslist configuration
5.2.6. Testing LDAP configuration
5.3. Configure ZCP Active Directory integration
5.3.1. Installing the Zarafa ADS Plugin and schema files
5.3.2. Configuring ZCP for ADS
5.3.3. User configuration
5.3.4. Group configuration
5.3.5. Addresslist configuration
5.3.6. Testing Active Directory configuration
5.4. ZCP Postfix integration
5.4.1. Configure ZCP Postfix integration with OpenLDAP
5.4.2. Configure ZCP Postfix integration with Active Directory
5.4.3. Configure ZCP Postfix integration with virtual users
5.5. Configure Z-Push (Remote ActiveSync for Mobile Devices)
5.5.1. Compatibility
5.5.2. Security
5.5.3. Installation
5.5.4. Mobile Device Management
5.5.5. Upgrade
5.5.6. Troubleshooting
6. Advanced Configurations
6.1. Running ZCP components beyond localhost
6.2. Multi-tenancy configurations
6.2.1. Support user plugins
6.2.2. Configuring the server
6.2.3. Managing company spaces
6.2.4. Managing users and groups
6.2.5. Quota levels
6.3. Multi-server setup
6.3.1. Introduction
6.3.2. Prepare / setup the LDAP server for multi-server setup
6.3.3. Configuring the servers
6.3.4. Creating SSL certificates
6.4. Zarafa Windows Client Updater
6.4.1. Server-side configuration
6.4.2. Client-side configuration
6.5. Running ZCP Services with regular user privileges
6.6. Single Instance Attachment Storage
6.6.1. Single Instance Attachment Storage and LMTP
6.7. Single-Sign-On with ZCP
6.7.1. Before attempting Single-Sign-On (SSO)
6.7.2. SSO with ADS
6.7.3. SSO with Samba
6.7.4. Up and running
7. Managing ZCP Services
7.1. Starting the services
7.1.1. Stopping the services
7.1.2. Reloading service configuration
7.2. Logging options
7.3. Soft Delete system
8. User Management
8.1. Public store
8.2. Users
8.2.1. Creating users
8.2.2. Non-active users
8.2.3. Updating stores and user information
8.2.4. Deleting users
8.2.5. ‘Send as’ Permissions
8.3. Groups
8.3.1. Creating groups using zarafa-admin
8.4. Other admin commands
8.5. User Management with LDAP or Active Directory
8.5.1. The Zarafa user synchronization principle
8.5.2. Add/Remove events
8.5.3. Group membership
8.5.4. LDAP server dependency
8.5.5. Setting up the LDAP repository
8.6. Send as Permissions option
8.7. Hide information from Global Address Book
8.8. Address lists by condition
8.8.1. Setup addresslists in OpenLDAP
8.8.2. Setup addresslists in Active Directory
8.8.3. Condition examples
9. Performance Tuning
9.1. Hardware Considerations
9.1.1. Memory usage
9.1.2. Hardware considerations
9.1.3. More Memory is More Speed
9.1.4. RAID 1/10 is faster than RAID 5
9.1.5. High rotation speed (RPMs) for better database performance
9.1.6. Hardware RAID
9.2. Memory Usage setup
9.2.1. Zarafa’s Cell Cache (cache_cell_size)
9.2.2. Zarafa’s object cache (cache_object_size)
9.2.3. Zarafa’s indexedobject cache (cache_indexedobject_size)
9.2.4. MySQL innodb_buffer_pool_size
9.2.5. MySQL innodb_log_file_size
9.2.6. MySQL innodb_log_buffer_size
9.2.7. MySQL query_cache
9.2.8. Setup of modules on different servers
10. Backup & Restore
10.1. Softdelete cache
10.2. Full database dump
10.2.1. SQL dump through mysqldump
10.2.2. Binary data dump via LVM Snapshotting
10.2.3. Attachments backup
10.3. Brick-level backups
10.3.1. Backup format
10.3.2. Backup process
10.3.3. Restore process
11. Appendix A; Pre-5.2x upgrade strategies
11.1. Database upgrades from 4.1 or 4.2
11.2. Upgrades from 5.0 to 5.1x and up
11.3. Important changes since 4.x and 5.x