Univention Corporate Server (UCS) is a Debian GNU/Linux-based enterprise server operating system with integrated management system for the central administration of servers, services, clients, desktops and users. The Zarafa Collaboration Platform (ZCP) combines the usability of Outlook with the stability and flexibility of a Linux server. Zarafa4UCS provides the integration of the Zarafa Collaboration Platform into Univention Corporate Server. It takes care of the installation of Zarafa and its configuration for the LDAP directory and the email stack. Users and groups in UCS will be available for Zarafa.

This installation guide offers step-by-step instructions for the installation of Zarafa4UCS and how to get started with the user and group management in UCS for the use with Zarafa.

1. Preparation

In order to install and operate Zarafa on UCS, Univention Corporate Server (UCS 3.0-1 or newer) has to be installed first, if not already present in your environment. Afterwards, the packages for Zarafa and Zarafa4UCS have to be downloaded and extracted into a local Zarafa4UCS repository. The local Zarafa4UCS repository has only to be setup on one UCS system in the environment.

1.1. Download

Download and installation of Univention Corporate Server (UCS) is described in the UCS Quickstart Guide. Recommended system roles for Zarafa on UCS are domain controller master, domain controller backup and domain controller slave. Please remember the IP address of the installed system. It will be summarized at the end of the installation. You need it to login via SSH or use the webbased management system in your webbrowser.

The Zarafa binary packages for UCS can be downloaded from the Zarafa Portal. In the Zarafa Portal please go to Download, choose the appropriate final release of Zarafa (ZCP) and choose the distribution entry "Univention" and select the version of Univention Corporate Server you operate and your preferred architecture. The packages are available for i386 and amd64. Zarafa recommends to run on a 64 bit architecture (x86_64) whenever possible.

The Zarafa4UCS package can be download from the Zarafa Community Hub. The file includes all necessary dependent binary packages for Zarafa for the installation on UCS.

Download both architectures for Zarafa and Zarafa4UCS and save the tar.gz files in one directory on UCS.

1.2. Create Zarafa4UCS repository

For the installation of Zarafa4UCS a separate repository is recommended for easier installation and package management. The following steps have to be done for each architecture (i386 and x86_64), but only if both architectures are present in UCS environment. Otherwise the steps are only necessary for the one architecture present in the environment.

  • Create a temporary zarafa4ucs directory and extract the downloaded files into it.

mkdir -p /tmp/zarafa4ucs
cd /tmp/zarafa4ucs
tar -xzf ~/zcp-7.0<version>.tar.gz
cd zcp-7.0<version>
tar -xzf ~/zarafa4ucs-<version>.tar.gz
chown -R root:root *
  • The files have to be moved to the respective repository directory and split into subdirectories depending on the architecture used. The packages files Packages and Packages.gz have to be updated, as well:

sh update-local-repository
  • Clean up and remove the temporary directory:

rm -Rf /tmp/zarafa4ucs

1.3. Add Zarafa4UCS repository

To install Zarafa4UCS and Zarafa, the Zarafa4UCS repository needs to be added to the repository list. Simply set the appropriate Univention Configuration Registry (UCR) variables for the repository. It will add the Zarafa4UCS repository definition to the file /etc/apt/sources.list.d/20_ucs-online-component.list automatically and checks the availability. The value for the repository server should be defined by the FQDN to the system providing the Zarafa4UCS repository. It also enables Zarafa4UCS as component in UCS to simplify the installation with the UMC module Online Updates:

ucr set update/secure_apt="no"
ucr set repository/online/component/zarafa4ucs/description="Zarafa4UCS"
ucr set repository/online/component/zarafa4ucs/server=<FQDN Zarafa repository server>
ucr set repository/online/component/zarafa4ucs/defaultpackages=zarafa4ucs
ucr set repository/online/component/zarafa4ucs/version=current
ucr set repository/online/component/zarafa4ucs=enabled

This definition should be added to every system, where packages related to Zarafa4UCS need to be installed.

1.4. Update

For the update of Zarafa4UCS, just download the new versions of ZCP and Zarafa4UCS and walk through the steps outlined in the section Create Zarafa4UCS repository above. This will add the new package versions to the local Zarafa4UCS repository and also update the files Packages and Packages.gz. Afterwards, just update the package zarafa4ucs, either on the command-line or in the UMC module Online Updates.

2. Installation

The installation of Zarafa4UCS can be done in two alternate steps that are described in the following sections. Zarafa is available on UCS after the installation of Zarafa4UCS. Zarafa Webaccess is directly linked from the welcome page of UCS.

2.1. Webbased via UCS management system

To install Zarafa using the webbased management system, the following steps should be processed:

  • Open the UCS management system in a webbrowser using the IP address of your Univention Corporate Server system.

  • On the overview page Univention Management Console should be selected.

  • Login with Administrator and the password provided during installation.

  • In the Overview go down to the section System and choose the UMC module Online Update.

  • Open the Tab Components.

  • The installation of Zarafa4UCS can be started with a click on Install.

2.2. Text-based via console

To install Zarafa on the console, just issue the following command:

univention-install zarafa4ucs

3. First steps

To start using Zarafa on UCS, users and groups can be created and assigned certain Zarafa roles. It can be done with Univention Directory Manager available in the UCS management system. Newly created users have the Zarafa role Zarafa User by default. They have a mailbox and the user is enabled to login to Zarafa. A group can be made available to Zarafa. The group can be addressed by the defined email address and every group member receives the email. The group also shows up in the recipient wizard in Zarafa itself.

3.1. Add a user

  • Open the users assistent and click Add user

  • Choose either the user template None or Zarafa Account

  • Fill in at least the required properties last name, username, password and primary email address

  • Set additional Zarafa options on the Zarafa tab

The following settings can be made for a user:

  • Zarafa roles: Zarafa User, Zarafa Admin, Zarafa Shared Store and Zarafa Contact. If a user shall not have a Zarafa account, set the Zarafa role to None.

  • Delegates defines the users that are allowed to send emails in the name of the user edited

  • Quota can be defined in MB for the levels warning, soft and hard quota

  • Hide entry from addressbook

  • Auto accept meeting requests

  • Auto decline meeting requests with conflicting times

  • Auto decline recurring meeting requests

  • Override global quota settings

3.2. Add a group

  • Open the groups assistant and click Add group

  • Provide a name for the group and assign group members

  • Set group options for Zarafa on the Zarafa tab

  • An email address my be optionally specified on the Advanced settings tab

The following settings can be made for a group:

  • Zarafa group

  • Hide group from addressbook

4. Configuration and Customization

Zarafa4UCS provides a default configuration for Zarafa and Zarafa can be used out-of-the-box. The following sections introduce how to customize the default configuration.

4.1. Change default for Zarafa role

After the installation of Zarafa4UCS the default value for the Zarafa role can be customized.

  • Login to the UCS management system

  • Open the Navigation

  • In the Navigation tree go to univentioncustom attributeszarafa and open the extended attribute zarafa-role

  • Go to the tab Data type and change the value in the field Default Value to one of the following values: user, admin, store, contact or none.

  • Click on Save changes

  • To make the changes effective for new user to be added, a re-login to the UCS management system is necessary.

4.2. Customize Zarafa configuration with UCR

The Zarafa configuration files can be edited directly with a simple text editor. Nevertheless, UCS and Zarafa4UCS provide a flexible way to manage the settings in Zarafa configuration files with Univention Configuration Registry (UCR). Both methods can be mixed. The following section describes the customization of the Zarafa configuration files using UCR.

By setting UCR variables containing the prefix zarafa/cfg/ the configuration files in /etc/zarafa/ may be modified. The name of the UCR variable has to contain the configuration file name (without the file suffix .cfg) and the option to be set within the configuration file.

For example, the following command will set the option imaps_enable = yes in the configuration /etc/zarafa/gateway.cfg:

ucr set zarafa/cfg/gateway/imaps_enable="yes"

If the specified option already exists, the value will be changed, otherwise the option will be appended at the end of the configuration file.

A similar mechanism is used to set values in /etc/default/zarafa. A UCR variable whose name is conform to the format zarafa/default/<option> will set the specified option in /etc/default/zarafa. For example:

ucr set zarafa/default/ZARAFA_LOCALE="de_DE.UTF-8"

If an option has been set via the described UCR mechanism, a short warning text will be added to the configuration file in the line prior to the line of the option.

UCR variables can also be set through the UCS management system in the UMC module Univention Configuration Registry.

5. Further information

Further information about Zarafa Collaboration Platform and Univention Corporate Server (UCS) can be found in the respective documentation.